Create Purchase Order

Shipper API gives interface access to our clients for creating or pushing Purchase Order API from their own system to Shipper Warehouse Management System

Authorizations : X-API-Key_Header
Request Body Schema : application/json

POST Create Purchase Order

Method	Endpoint
POST	/v3/fulfillment/inbound

Body Request Parameter

Field	Data Type	Description	Note
warehouse_id	string(20)	Warehouse Code Example: 10004450572511	Mandatory You can check warehouse_id using this end point: /v3/fulfillment/client/information
po_type	string(20)	Normal PO (CG), Return to warehouse (RT) Example: CG	Mandatory Valid values: CG, RT
doc_no	string(40)	Purchase Order No or Inbound Return No Example: SO21090300003	Mandatory No special character
po_creation_time	yyyy-MM-ddThh:mm:ssZ	Doc Created Date Timestamp Example: 2021-01-01:22:23:24Z	Mandatory
expected_arrive_time_1	yyyy-MM-ddThh:mm:ssZ	Expected Arrive Time Example: 2006-01-02T15:04:05Z	Mandatory To better calculate Inbound SLA
supplier_id	string(30)	Registered Supplier Identification Example: SHIPPEROUTLETTUJUH	Check Supplier using this endpoint: /v3/fulfillment/suppliers
notes	string(500)	Additional notes for inbound Example: 'Barang Retur'	Optional
DETAILS
line_no	Integer	Line Number Example: 90	Mandatory Minimum value is '1'
customer_id	string(30)	Customer ID, will be registered by Shipper Technical Team for new client. Example: CS436	Optional
sku	string(50)	Product Identifier Code Example: SK18319U	Mandatory
ordered_qty	Integer	QTY Order Example: 5	Mandatory Minimum value is '1'
total_price	decimal(18, 8)	Price for an item Example: 1000.00	Optional
notes	text(200)	More note about item detail	Optional
mfg_date	yyyy-MM-dd	Manufacturing Date Example : 2021-01-01	Optional
exp_date	yyyy-MM-dd	Expire Date Example : 2021-01-01	Optional
batch_no	string(100)	Batch Number	Optional
serial_no	string(100)	Serial Number	Optional

Sample Body Request

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

{
    "data": {
        "inbound": {
            "warehouse_id": "WH-TGR04",
            "po_type": "CG",
            "doc_no": "PO20210921-ZZ2",
            "po_creation_time": "2021-09-15T13:00:00Z",
            "supplier_id": "SIRCLO",
            "details": [
                {
                    "line_no": 1,
                    "sku": "AHNA0002",
                    "ordered_qty": 1000
                }
            ]
        }
    }
}

{
    "data": {
        "inbound": {
            "warehouse_id": "WH-TGR04",
            "po_type": "CG",
            "doc_no": "PO20210921-ZZ2",
            "po_creation_time": "2021-09-15T13:00:00Z",
            "supplier_id": "SIRCLO",
            "notes": "RETURN",
            "details": [
                {
                    "line_no": 1,
                    "batch_no": 12345,
                    "serial_no": 12345,
                    "customer_id": "SIRCLO",
                    "sku": "AHNA0002",
                    "ordered_qty": 10,
                    "total_price": 5000.00
                }
            ]
        }
    }
}

Sample Response

{
    "metadata": {
        "path": "/v3/fulfillment/inbound",
        "http_status_code": 201,
        "http_status": "Created",
        "timestamp": 1615969609
    },
    "data": {
        "request_id": "inbound.2021.03.19080537.123456"
    }
}

{
  "metadata": {
    "path": "/v3/fulfillment/inbound",
    "http_status_code": 400,
    "http_status": "Bad Request",
    "errors": [
      {
        "code": 810,
        "message": "Invalid Input. Please Validate Your Input."
      }
    ],
    "timestamp": 1637742950
  }
}

{
  "metadata": {
    "path": "/v3/fulfillment/inbound",
    "http_status_code": 401,
    "http_status": "Unauthorized",
    "errors": [
      {
        "code": 10001,
        "message": "Unauthorized Access. You are not authorized to access this resource."
      }
    ],
    "timestamp": 1637743062
  }
}

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

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