Sign in

v3

latestOpenAPI 3.1.02026-08-0619186200.1 KB
Orders

Get Order

This endpoint can be used to retrieve data from the order you are calling.The order can be in following 4 statuses (field order_status):

  • unfulfilled indicates an order is ready for ShipMonk to process
  • cancelled indicates an order was cancelled
  • fulfilled indicates an order has been marked as "Fulfilled by 3rd party", unless already fulfilled by ShipMonk
  • onHold indicates an order is placed on hold

You can retrieve orders from all of your stores. In case you have not unique orderKeys across stores you can specify the storeId.

get/v1/integrations/orders

Query parameters

orderKeystring nullable

Filter by the external system's unique order identifier (order_key). Returns only orders matching this value; omit to skip this filter.

orderNumberstring nullable

Filter by the customer-facing order identifier (order_number). Returns only orders matching this value; omit to skip this filter.

storeIdinteger nullable

Filter by the internal numeric identifier of the store that owns the order. Omit to return orders across all stores.

Response

Success

statusinteger required