GET Purchase Order Detail by Order Number

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

GET Purchase Order Detail Data

Field	Endpoint
GET	/v3/fulfillment/warehouse/{warehouse_id}/inbound/{order_number}

Path Parameter

Field	Data Type	Description	Notes
warehouse_id	String	Registered warehouse identification Example: WH-TGR04	Mandatory
order_number	String	Registered Order Number Example: PO000019	Mandatory

Field

Data Type

Description

Notes

warehouse_id

String

Registered warehouse identification

Example: WH-TGR04

Mandatory

order_number

String

Registered Order Number

Example: PO000019

Mandatory

Response Parameter

Field	Data Type	Description	Note
warehouse_id	String	Registered Warehouse Identification	Available
order_no	String	Registered Order Number	Available
po_status	String	Purchase Order Status, divided by 4 categories, “CREATED”, “PROCESSING“, “CLOSED“, “CANCELLED“	Available
order_type	String	“CG” for Normal Inbound. “RT” for Inbound Return	Available
supplier_id	String	Registered Supplier Identification	Available
po_date	yyyy-MM-dd HH:mm:ss	Purchase Order Created Date	Available
DETAILS
reference_no	String	Purchase Order No	Available
line_no	Integer	Line No	Available
sku	String	SKU Code (Registered at WMS)	Available
pack_id	String	UoM Conversion ID	Available
received_time	yyyy-MM-dd HH:mm:ss	Goods Received Date Time	Available
expected_qty	Integer	QTY Expected from SKU	Available
received_qty	Integer	QTY Received from SKU	Available
mfg_date	yyyy-MM-dd	Manufacturing Date	Available
exp_date	yyyy-MM-dd	Expired Date	Available
batch_no	String	Batch No	Available
serial_no	String	Serial No	Available
receipt_date	yyyy-MM-dd HH:mm:ss	Receipt Date	Return Empty String
product_condition	String	Product Condition such as OK, Damage	Available
grn_no	String	GRN No	Available
notes	String	Remarks	Available

Sample Query Parameters Request

/v3/fulfillment/inbounds?warehouse_id=WH-TGR04&po_type=CG&po_status=CREATED&created_start=2021-04-01&created_end=2021-04-10&updated_start=2021-04-01&updated_end=2021-04-10&page=1&limit=10&sort_by=po_status

Sample Body Response

{
  "metadata": {
    "path": "/v3/fulfillment/warehouse/WH-TGR04/inbound/PO000019?%3Aorder_number=PO000019&%3Awarehouse_id=WH-TGR04&",
    "http_status_code": 200,
    "http_status": "OK",
    "timestamp": 1637654084
  },
  "data": {
    "inbound": {
      "warehouse_id": "WH-TGR04",
      "order_no": "",
      "po_status": "CREATED",
      "order_type": "CG",
      "po_date": "2021-04-01",
      "supplier_id": "",
      "details": [
        {
          "reference_no": "",
          "line_no": 1,
          "sku": "JTA-ARROWS",
          "pack_id": "JTA-ARROWS",
          "received_time": "",
          "expected_qty": 500,
          "received_qty": 0,
          "mfg_date": "",
          "exp_date": "",
          "batch_no": "",
          "serial_no": "",
          "receipt_date": "",
          "product_condition": "N",
          "grn_no": "ASN21040100004",
          "notes": ""
        },
        {
          "reference_no": "",
          "line_no": 2,
          "sku": "P-NYERILUTUT",
          "pack_id": "P-NYERILUTUT",
          "received_time": "",
          "expected_qty": 200,
          "received_qty": 0,
          "mfg_date": "",
          "exp_date": "",
          "batch_no": "",
          "serial_no": "",
          "receipt_date": "",
          "product_condition": "N",
          "grn_no": "ASN21040100004",
          "notes": ""
        }
      ]
    }
  }
}

{
    "metadata": {
        "path": "/v3/fulfillment/warehouse/WG-123/inbound/PO-1999?%3Aorder_number=PO-1999&%3Awarehouse_id=WG-123&",
        "http_status_code": 401,
        "http_status": "Unauthorized",
        "errors": [
            {
                "code": 10001,
                "message": "Unauthorized Access. You are not authorized to access this resource."
            }
        ],
        "timestamp": 1637654466
    }
}

{
  "metadata": {
    "path": "/v3/fulfillment/warehouse/WG-123/inbound/PO000019?%3Aorder_number=PO000019&%3Awarehouse_id=WG-123&",
    "http_status_code": 404,
    "http_status": "Not Found",
    "errors": [
      {
        "code": 10004,
        "message": "Record Does Not Exist. Please Validate Your Input Or Contact Administrator."
      }
    ],
    "timestamp": 1637654251
  }
}

{
  "metadata": {
    "path": "/v1/fulfillment/client/information",
    "http_status_code": 500,
    "http_status": "Internal Server Error",
    "errors": [
      {
        "code": 803,
        "message": "Internal Server error."
      }
    ],
    "timestamp": 1637555484
  }
}

Status	Reason
200	Success
401	Invalid API Key
404	Invalid PO Order Number
500	Server Error Please contact Shipper's representative