Orders

Get Order

Changed on

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

Request

  • Base URL: https://api.shipmonk.com
  • URL: https://api.shipmonk.com/v1/integrations/orders
  • Auth: API key in header Api-Key

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

Changes

  • ba12ca290609Revision changes
    • warning

      added the new gofoexpress enum value to the //// response property for the response status

  • f63d8ca36b24Revision changes
    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status