Goods shipped report

get

https://api.mrpeasy.com/rest/v2/customers/statistics/goods-shipped

Summary of shipped goods for the requested period.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

start_date

integer | null

Start of the reporting period as a Unix timestamp.

end_date

integer | null

End of the reporting period as a Unix timestamp.

article_id

integer | null

Filter by item variation (article) id (exact match).

product_code

string | null

Filter by product number (partial match).

product_title

string | null

Filter by product name (partial match).

group_id

integer | null

Filter by product group id.

group_code

string | null

Filter by product group number (partial match).

group_title

string | null

Filter by product group name (partial match).

unit_id

integer | null

Filter by unit of measure id (exact match).

unit

string | null

Filter by unit of measure name (partial match).

quantity_sum_min

string | null

Minimum shipped quantity.

quantity_sum_max

string | null

Maximum shipped quantity.

total_sum_min

string | null

Minimum total selling price.

total_sum_max

string | null

Maximum total selling price.

total_cost_min

string | null

Minimum total cost.

total_cost_max

string | null

Maximum total cost.

total_profit_min

string | null

Minimum total profit (may be negative).

total_profit_max

string | null

Maximum total profit (may be negative).

total_profit_percent_min

string | null

Minimum profit margin in percent (may be negative).

total_profit_percent_max

string | null

Maximum profit margin in percent (may be negative).

materials_cost_min

string | null

Minimum materials cost.

materials_cost_max

string | null

Maximum materials cost.

manufacturing_cost_min

string | null

Minimum manufacturing cost.

manufacturing_cost_max

string | null

Maximum manufacturing cost.

labour_cost_min

string | null

Minimum labour cost.

labour_cost_max

string | null

Maximum labour cost.

avg_delay_min

string | null

Minimum average delay in days (fractional allowed).

avg_delay_max

string | null

Maximum average delay in days (fractional allowed).

on_time_rate_min

string | null

Minimum on-time shipment rate in percent.

on_time_rate_max

string | null

Maximum on-time shipment rate in percent.

limit

integer

Maximum number of records to return (1–1000).

offset

integer

Number of records to skip for pagination.

Responses

401

Unauthorized

413

Content Too Large - please use smaller ´limit´

429

Too many requests

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200List of per-item turnover rows for the requested period

422Validation error