GET Sales Order Detail WMS by Order Number

Shipper API gives interface access to our clients for retrieving or pulling Sales Order Detail by ID API from Shipper Warehouse Management System

GET Sales Order Detail for B2B

Field	Endpoint
GET	/v3/fulfillment/warehouse/{warehouse_id}/outbound/wms/{order_no}

Query Parameter

Field	Data Type	Description	Notes
order_number	String	Order Number	Mandatory
warehouse_code	String	Warehouse code given by Shipper	Mandatory

Sample Query Parameters Request

Header	How to fill
x-api-key	Shipper api key

/v3/fulfillment/warehouse/WH-TGR04/outbound/wms/SO812391

Sample Body Response

Header	How to fill
x-request-id	Request ID generated from Shipper for tracking purposes

{
  "metadata": {
    "path": "/v3/fulfillment/warehouse/WH-TGR04/outbound/wms/SO812391?%3Aorder_number=SO812391&%3Awarehouse_id=WH-TGR04&",
    "http_status_code": 200,
    "http_status": "OK",
    "timestamp": 1637906347
  },
  "data": {
    "outbound": {
      "order_no": "SO812391",
      "order_type": "B2B",
      "so_status": "CREATED",
      "warehouse_id": "WH-TGR04",
      "consignee_id": "",
      "consignee_name": "Customer Desc 01",
      "release_status": true,
      "order_time": "2021-08-30T18:15:30Z",
      "wave_no": "",
      "so_reference_1": "",
      "so_reference_2": "",
      "so_reference_3": "",
      "so_reference_4": "",
      "so_reference_5": "",
      "consignee_address_1": "",
      "consignee_city": "",
      "billing_id": "",
      "carrier_name": "BARAKA EXPRESS",
      "delivery_no": "*",
      "udf_01": "",
      "udf_02": "",
      "udf_03": "",
      "udf_04": "",
      "udf_05": "",
      "notes": "",
      "details": [
        {
          "sku": "SIT001",
          "order_line": 0,
          "line_status": "",
          "sku_descr": "",
          "qty_ordered": 1,
          "qty_released": 0,
          "qty_allocated": 0,
          "qty_picked": 0,
          "qty_shipped": 0,
          "pack_id": "",
          "udf_01": "",
          "udf_02": "",
          "udf_03": "",
          "udf_04": "",
          "udf_05": "",
          "mfg_date": "2021-08-30",
          "exp_date": "2021-08-30",
          "batch_no": "2021-08-30",
          "serial_no": "",
          "receipt_date": null,
          "product_condition": ""
        }
      ]
    }
  }
}

{
  "metadata": {
    "path": "/v3/fulfillment/warehouse/WH-TGR04/outbound/wms/12312312?%3Aorder_number=12312312&%3Awarehouse_id=WH-TGR04&merchant_id=1011834",
    "http_status_code": 400,
    "http_status": "Bad Request",
    "errors": [
      {
        "code": 810,
        "message": "No organization id found for customer MDS or warehouse WH-TGR04"
      }
    ],
    "timestamp": 1652262388
  }
}

{
  "metadata": {
    "path": "/v3/fulfillment/warehouse/WH-TGR04/outbound/wms/12312312?%3Aorder_number=12312312&%3Awarehouse_id=WH-TGR04&merchant_id=1011834",
    "status_code": 401,
    "status": "Unauthorized",
    "message": "GET /v1/fulfillment/warehouse/WH-TGR04/outbound/wms/12312312?%3Aorder_number=12312312&%3Awarehouse_id=WH-TGR04&merchant_id=1011834 [401] Unauthorized",
    "error": {
      "code": 802,
      "message": "Unauthorized Access. You are not authorized to access this resource."
    },
    "timestamp": "2022-05-11T09:47:16Z"
  }
}

{
  "metadata": {
    "path": "/v3/fulfillment/warehouse/WH-TGR04/outbound/wms/TEST123X?%3Aorder_number=TEST123X&%3Awarehouse_id=WH-TGR04&",
    "http_status_code": 404,
    "http_status": "Not Found",
    "errors": [
      {
        "code": 10004,
        "message": "Record Does Not Exist. Please Validate Your Input Or Contact Administrator."
      }
    ],
    "timestamp": 1637906128
  }
}

{
    "metadata": {
        "path": "/v3/fulfillment/warehouse/WH-TGR04/outbound/wms/12312312?%3Aorder_number=12312312&%3Awarehouse_id=WH-TGR04&merchant_id=1011834",
        "http_status_code": 500,
        "http_status": "Internal Server Error",
        "errors": [
            {
                "code": 10003,
                "message": "Internal Server Error. Please Call Administrator."
            }
        ],
        "timestamp": 1637906128
    }
}