GET List Purchase Order

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

GET Create Master Data

Field	Endpoint
GET	/v3/fulfillment/inbounds

Query Parameter

Field	Data Type	Description	Mandatory Field
created_start	yyyy-MM-dd	Start Date for searching Purchase Order by creation date Example: 2021-11-01	Optional
created_end	yyyy-MM-dd	End Date for searching Purchase Order by creation date Example: 2021-11-01	Optional
updated_start	yyyy-MM-dd	Start Date for searching Purchase Order by updated date Example: 2021-11-01	Optional
updated_end	yyyy-MM-dd	End Date for searching Purchase Order by updated date Example: 2021-11-01	Optional
warehouse_id	String	Registered warehouse identification Example: WH-TGR04	Optional
po_type	String	PO Type : “CG” for Normal Inbound. “RT” for Inbound Return	Optional
po_status	String	Purchase Order Status, divided by 4 categories, “CREATED”, “PROCESSING“, “CLOSED“, “CANCELLED“	Optional
page	Integer	Page Number Example: 1	Optional
limit	Integer	Item Limit per Page Example: 100	Optional
sort_by	String [Array]	Sort by Attributes: po_type, po_status	Optional

Body Response

Field	Data Type	Description	Note
warehouse_id	String	Registered warehouse identification	Available
order_no	String	Order number’s PO	Available
po_status	String	Purchase Order Status	Available
order_type	String	Order type	Available Value: “CG” for Normal Inbound or “RT” for Inbound Return
po_date	yyyy-MM-dd	Purchase Order Created Date	Available

Sample Query Parameters Request

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

/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

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/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",
    "http_status_code": 200,
    "http_status": "OK",
    "timestamp": 1637652606
  },
  "data": {
    "inbounds": [
      {
        "warehouse_id": "WH-TGR04",
        "order_no": "PO000018",
        "po_status": "CREATED",
        "order_type": "CG",
        "po_date": "2021-04-01"
      }
    ]
  }

{
  "metadata": {
    "path": "/v3/fulfillment/inbounds?warehouse_id=WH-TGR04&po_type=CGA&po_status=CREATED&created_start=2021-04-01&created_end=2021-04-01&updated_start=2021-04-01&updated_end=2021-04-01&page=1&limit=10&sort_by=po_status",
    "http_status_code": 400,
    "http_status": "Bad Request",
    "errors": [
      {
        "code": 800,
        "message": "Invalid Input. Please Validate Your Input."
      }
    ],
    "timestamp": 1637653255
  }
}

{
  "metadata": {
    "path": "/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",
    "http_status_code": 401,
    "http_status": "Unauthorized",
    "errors": [
      {
        "code": 10001,
        "message": "Unauthorized Access. You are not authorized to access this resource."
      }
    ],
    "timestamp": 1637653095
  }
}

{
  "metadata": {
    "path": "/v3/fulfillment/inbounds?warehouse_id=WH-TGR04&po_type=CG&po_status=CREATED&created_start=2021-04-01&created_end=2021-04-01&updated_start=2021-04-01&updated_end=2021-04-01&page=1&limit=10&sort_by=po_status",
    "http_status_code": 404,
    "http_status": "Not Found",
    "errors": [
      {
        "code": 801,
        "message": "Record Does Not Exist. Please Validate Your Input Or Contact Administrator."
      }
    ],
    "timestamp": 1637652836
  }
}

Status	Reason
201	PO Creation success
400	Please check your input. Make sure the JSON payload is correct Make sure the requested input are valid.
401	Please check whether your API Key is valid and still active.
500	Something wrong with Shipper application. Please contact Shipper representative.