fetch_order_status
HTTP Method: POST

get's an order's status. If an order is not found, no status will be returned

Endpoint

https://api.finerworks.com/v3/fetch_order_status


Authorization Credentials
Must include in header or as querystring parameters during request.

Name/KeyDescriptionTypeAdditional information
web_api_key

Can be found here within your FinerWorks account.

text

Required

app_key

Can be generated here within your FinerWorks account.

text

Required

Body Parameters

Order udpate details to be submitted via XML or JSON

NameDescriptionTypeAdditional information
order_ids

List of unique order submission reference ids you received after your order was successfully submitted.

array (number)

Required

Example

application/json, text/json

{
  "order_ids": [
    1,
    2
  ]
}

NameDescriptionTypeAdditional information
status

response_status

None.

orders

array (order_status)

None.

Example

application/json, text/json

{
  "status": {
    "success": true,
    "status_code": 100,
    "message": "sample string 2",
    "debug": {
      "ClassName": "System.Exception",
      "Message": null,
      "Data": null,
      "InnerException": null,
      "HelpURL": "sample string 1",
      "StackTraceString": null,
      "RemoteStackTraceString": null,
      "RemoteStackIndex": 0,
      "ExceptionMethod": null,
      "HResult": 3,
      "Source": "sample string 2",
      "WatsonBuckets": null
    }
  },
  "orders": [
    {
      "order_confirmation_id": 1,
      "order_po": "sample string 2",
      "order_id": 3,
      "order_status_label": "sample string 4",
      "shipments": [
        {
          "shipment_date": "2019-03-22T19:16:45.1448504-05:00",
          "delivery_date": "2019-03-22T19:16:45.1448504-05:00",
          "weight": 3.0,
          "width": 4.0,
          "height": 5.0,
          "depth": 6.0,
          "tracking_number": "sample string 7",
          "tracking_url": "sample string 8"
        },
        {
          "shipment_date": "2019-03-22T19:16:45.1448504-05:00",
          "delivery_date": "2019-03-22T19:16:45.1448504-05:00",
          "weight": 3.0,
          "width": 4.0,
          "height": 5.0,
          "depth": 6.0,
          "tracking_number": "sample string 7",
          "tracking_url": "sample string 8"
        }
      ]
    },
    {
      "order_confirmation_id": 1,
      "order_po": "sample string 2",
      "order_id": 3,
      "order_status_label": "sample string 4",
      "shipments": [
        {
          "shipment_date": "2019-03-22T19:16:45.1448504-05:00",
          "delivery_date": "2019-03-22T19:16:45.1448504-05:00",
          "weight": 3.0,
          "width": 4.0,
          "height": 5.0,
          "depth": 6.0,
          "tracking_number": "sample string 7",
          "tracking_url": "sample string 8"
        },
        {
          "shipment_date": "2019-03-22T19:16:45.1448504-05:00",
          "delivery_date": "2019-03-22T19:16:45.1448504-05:00",
          "weight": 3.0,
          "width": 4.0,
          "height": 5.0,
          "depth": 6.0,
          "tracking_number": "sample string 7",
          "tracking_url": "sample string 8"
        }
      ]
    }
  ]
}