GET Sales Order List (WMS)

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

Specification

Field	Endpoint
GET	/v3/fulfillment/outbounds/{outbound_type}

Query Parameter

Field	Data Type	Description	Mandatory Field
outbound_type	string	Order Type Always input "WMS"	Mandatory
created_start	yyyy-MM-dd	Sales Order Created Start Date	Optional
created_end	yyyy-MM-dd	Sales Order Created End Date	Optional
updated_start	yyyy-MM-dd	Updated Start Date	Optional
updated_end	yyyy-MM-dd	Updated End Date	Optional
warehouse_id	String(20)	Warehouse Code	Optional
order_type	String(20)	Sales Order Type	Optional Value of: SO or RT or TT
so_status	String	WMS Sales Order Status The status is the operational process in the warehouse.	Optional Value: CREATED ALLOCATED PICKED PACKED CLOSED CANCELLED
page	Integer	Page Number	Optional
limit	Integer	Limit or Size Records Per Page	Optional

Body Response

Field	Data Type	Description	Note
order_no	String(60)	Sales Order No	Available
order_type	String	Order type	Available
so_status	String(20)	Sales Order Status	Available
warehouse_id	String(30)	Warehouse Code	Available
consignee_id	String(200)	Customer Code	Return Empty String
consignee_name	String	Customer Name	Return Empty String
release_status	String	Order Release Status	Available
order_time	yyyy-MM-dd HH:mm:ss	Order Created Date	Available
wave_no	Integer	Wave Plan Number	Return Empty String
so_reference_1	String(50)	Sales Order Reference No	Return Empty String
so_reference_2	String(50)	Sales Order Reference No	Return Empty String
so_reference_3	String(50)	Sales Order Reference No	Return Empty String
so_reference_4	String(50)	Sales Order Reference No	Not Available, Return Empty String
so_reference_5	String(50)	Sales Order Reference No	Not Available, Return Empty String
consignee_address_1	String	Customer Address	Return Empty String
consignee_city	String(255)	Customer City	Return Empty String
billing_id	Integer	Billing ID	Available
carrier_name	String(200)	Expedition Name	Available
delivery_no	String(60)	AWB	Available
udf_01	String(500)	Defined by User	Return Empty String
udf_02	String(500)	Defined by User	Return Empty String
udf_03	String(500)	Defined by User	Return Empty String
udf_04	String(500)	Defined by User	Return Empty String
udf_05	String(500)	Defined by User	Return Empty String
Notes	String	Remarks	Available

Sample Query Parameters Request

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

Sample Body Response

{
  "metadata": {
    "path": "/v3/fulfillment/outbounds/wms?merchant_id=6809212",
    "http_status_code": 200,
    "http_status": "OK",
    "timestamp": 1637724983
  },
  "data": {
    "outbounds": [
      {
        "order_no": "",
        "order_type": "B2C",
        "so_status": "ALLOCATED",
        "warehouse_id": "WH-TGR01",
        "consignee_id": "",
        "consignee_name": "",
        "release_status": true,
        "order_time": "2021-09-07T13:39:29Z",
        "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": "",
        "delivery_no": "*",
        "udf_01": "",
        "udf_02": "",
        "udf_03": "",
        "udf_04": "",
        "udf_05": "",
        "notes": ""
      },
      {
        "order_no": "",
        "order_type": "B2C",
        "so_status": "ALLOCATED",
        "warehouse_id": "WH-TGR01",
        "consignee_id": "",
        "consignee_name": "",
        "release_status": true,
        "order_time": "2021-09-07T13:41:16Z",
        "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": "",
        "delivery_no": "*",
        "udf_01": "",
        "udf_02": "",
        "udf_03": "",
        "udf_04": "",
        "udf_05": "",
        "notes": ""
      }
    ]
  }
}

{
  "metadata": {
    "path": "/v1/fulfillment/outbounds/wms?order_type=123&merchant_id=6809212",
    "http_status_code": 400,
    "http_status": "Bad Request",
    "errors": [
      {
        "code": 810,
        "message": "SOType harus berupa salah satu dari [SO RT]"
      }
    ],
    "timestamp": 1637725532
  }
}

{
  "metadata": {
    "path": "/v1/fulfillment/outbounds/wms?so_status=CREATED&merchant_id=68092121",
    "http_status_code": 401,
    "http_status": "Unauthorized",
    "errors": [
      {
        "code": 1301,
        "message": "You Are Not Registered In WMS System. Please Contact Administrator."
      }
    ],
    "timestamp": 1637725452
  }
}

{
  "metadata": {
    "path": "/v1/fulfillment/outbounds/wms?so_status=ALLOCATED&merchant_id=6809212",
    "http_status_code": 404,
    "http_status": "Not Found",
    "errors": [
      {
        "code": 801,
        "message": "Record Does Not Exist. Please Validate Your Input Or Contact Administrator."
      }
    ],
    "timestamp": 1637725477
  }
}