arrow_back Back to all endpoints
POST https://test-api.finerworks.com/v3/fetch_order_status

Get Order Status

Retrieves an order's current "production" status. If an order is not found, no status will be returned.

Body

Order udpate details to be submitted via XML or JSON

Name Description Type Additional information
order_pos List of unique order submission order_pos. array (text) None.
order_ids List of unique order submission reference ids you received after your order was successfully submitted. Not required if submitting order_pos array (number) None.
account_key Optional - This will only be accepted for accounts with permission to utilize this parameter, otherwise it will be ignored and any get orders will be based upon the user's api credentials. Leave as null or ignore if not explicitly required to use this parameter. text None.

Example JSON Body

application/json, text/json

{
  "order_pos": null,
  "order_ids": [
    123456,
    123457
  ],
  "account_key": null
}

Sample Code Library

curl --location --request POST 'https://test-api.finerworks.com/v3/fetch_order_status' \
--header 'Content-Type: application/json' \
--header 'web_api_key: my-web-api-key-goes-here' \
--header 'app_key: my-app-key-goes-here' \
--data-raw '{
  "order_pos": null,
  "order_ids": [
    123456,
    123457
  ],
  "account_key": null
}'