API Reference
  1. MRPeasy REST API
  2. Shipments

List shipments

get
https://api.mrpeasy.com/rest/v1/shipments
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

Database ID of the shipment.

string

A unique number to identify the shipment.

status
array of objects

Status of shipment.

  • 10 - New
  • 15 - Ready for shipment
  • 20 - Shipped
  • 30 - Cancelled

Arrays are supported, for example ?status[]=10&status[]=20.

status
Allowed:
string

A unique number to identify the customer, vendor or RMA-related company.

string

Name of the customer, vendor or RMA-related company.

integer

Database ID of the customer order.

string

A unique number to identify the customer order.

integer

Database ID of the RMA order.

string

A unique number to identify the RMA order.

integer

Database ID of the purchase order.

string

A unique number to identify the purchase order.

string

Reference of the related order.

string

Notes for the waybill.

string

Tracking number.

integer

ID of site where the shipped product is located.

integer

Minimum creation timestamp (Unix timestamp).

integer

Maximum creation timestamp (Unix timestamp).

integer

Minimum delivery date (Unix timestamp).

integer

Maximum delivery date (Unix timestamp).

Headers
string

Pagination range (e.g., items=0-99, items=200-249)

Responses

429

Rate limited - another request is running

Updated 4 months ago

Did this page help you?
Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?