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

MethodEndpointDescription
POST/v3/fulfillment/inbound

Body Request Parameter

📘

Notes

"Please Fill with Empty String / 0 / false" note means client still need to pass ““ / 0 / false value to that parameter.

Field

Data Type

Description

Note

warehouse_id

string(30)

Warehouse Code

Mandatory

po_type

string(20)

Normal PO (CG),

Return to warehouse (RT)

Mandatory

doc_no

string(20)

Purchase Order No or Inbound Return No

Example:

SO21090300003

Mandatory

po_creation_time

yyyy-MM-ddThh:mm:ssZ

Doc Created Date Timestam

Example:

2021-01-01:22:23:24Z

Mandatory

supplier_id

string(30)

Registered Supplier Identification

Example:

SHIPPEROUTLETTUJUH

Mandatory

po_reference_a

string(50)

Purchase Order Reference No

Please Fill with Empty String

po_reference_b

string(50)

Purchase Order Reference No

Please Fill with Empty String

po_reference_c

string(50)

Purchase Order Reference No

Please Fill with Empty String

po_reference_d

string(50)

Purchase Order Reference No

Please Fill with Empty String

expected_arrive_time_1

Datetime

PO Expected Arrived Time 1

Please Fill with Empty String

expected_arrive_time_2

Datetime

PO Expected Arrived Time 2

Please Fill with Empty String

hedi_01

string(200)

EDI Related Information

Please Fill with Empty String

hedi_02

string(200)

EDI Related Information

Please Fill with Empty String

supplier_name

string(200)

PO Supplier Name

Please Fill with Empty String

supplier_address_1

string(200)

Supplier Address 1

Please Fill with Empty String

supplier_address_2

string(200)

Supplier Address 2

Please Fill with Empty String

supplier_country

string(2)

Supplier Country code Location

Example : ID

Please Fill with Empty String

supplier_province

string(50)

Supplier Province Location

Example : DKI Jakarta

Please Fill with Empty String

supplier_city

string(50)

Supplier City Name

Example : Jakarta Selatan

Please Fill with Empty String

supplier_district

string(50)

Supplier District Name

Example : Gambir

Please Fill with Empty String

supplier_street

string(50)

Supplier Street Name

Example: Jalan Gambir No. 01

Please Fill with Empty String

supplier_contact

string(200)

Supplier Contact Name

Example : Mr.Brown

Please Fill with Empty String

supplier_fax

string(20)

Supplier Fax No

Please Fill with Empty String

supplier_mail

string(200)

Supplier Email Address

Please Fill with Empty String

supplier_tel_1

string(40)

Supplier Contact Phone

Please Fill with Empty String

supplier_tel_2

string(100)

Supplier Contact Phone 2

Please Fill with Empty String

supplier_zip

string(10)

Supplier ZIP Location

Please Fill with Empty String

issue_party_id

string(30)

-

Please Fill with Empty String

issue_party_name

string(200)

-

Please Fill with Empty String

user_define_1

string(200)

Defined by Shipper

Please Fill with Empty String

user_define_2

string(200)

Defined by Shipper

Please Fill with Empty String

user_define_3

string(200)

Defined by Shipper

Please Fill with Empty String

notes

string(500)

More note about the supplier

Please Fill with Empty String

Details

line_no

Integer

Line Number

Mandatory

customer_id

string(30)

Customer ID, will be registered by Shipper Technical Team for new client

Mandatory

sku

string(50)

Product Identifier Code

Example: SK18319U

Mandatory

ordered_qty

decimal(18, 8)

QTY Order

Mandatory

pack_id

string(30)

UoM Conversion ID, please use "EA"

Notes :

Ea = each = unit
Box = per box
Pallet = per pallet
Inner packs = In 1 box there are how many

Mandatory

mfg_date

yyyy-MM-dd

Manufacturing Date

Example : 2021-01-01

Optional

exp_date

yyyy-MM-dd

Expire Date

Example : 2021-01-01

Available, Optional

batch_no

string(100)

Batch Number

Optional

serial_no

string(100)

Serial Number

Optional

notes

text(200)

Remarks

Optional

receipt_date

Date

Goods Receipt Date

Please Fill with Empty String

product_condition

string(10)

Goods Product Condition

Please Fill with Empty String

total_price

decimal(18, 8)

Goods Total Price

Please Fill with 0 (Zero)

dedi_04

string(200)

EDI Related Information

Please Fill with Empty String

dedi_05

string(200)

EDI Related Information

Please Fill with Empty String

user_define_1

string(200)

Defined by Shipper

Please Fill with Empty String

user_define_2

string(200)

Defined by Shipper

Please Fill with Empty String

 

Sample Body Request

{
    "data": {
        "inbound": {
            "warehouse_id": "WH-TGR04",
            "po_type": "CG",
            "doc_no": "PO20210921-ZZ2",
            "po_creation_time": "2021-09-15T13:00:00Z",
            "supplier_id": "SIRCLO",
            "po_reference_a": "",
            "po_reference_b": "",
            "po_reference_c": "",
            "po_reference_d": "",
            "expected_arrival_time1": "",
            "expected_arrival_time2": "",
            "hedi_01": "",
            "hedi_02": "",
            "supplier_name": "",
            "supplier_address1": "",
            "supplier_address2": "",
            "supplier_country": "",
            "supplier_province": "",
            "supplier_city": "",
            "supplier_district": "",
            "supplier_street": "",
            "supplier_contact": "",
            "supplier_fax": "",
            "supplier_mail": "",
            "supplier_tel1": "",
            "supplier_tel2": "",
            "supplier_zip": "",
            "issuer_party_id": "",
            "issuer_party_name": "",
            "user_define1": "",
            "user_define2": "",
            "user_define3": "",
            "notes": "RETURN",
            "details": [
                {
                    "line_no": 1,
                    "customer_id": "SIRCLO",
                    "sku": "AHNA0002",
                    "ordered_qty": 1000,
                    "pack_id": "EA",
                    "mfg_date": "",
                    "exp_date": "",
                    "batch_no": "",
                    "serial_no": "",
                    "notes": "",
                    "receipt_date": "",
                    "product_condition": "",
                    "total_price": 0,
                    "dedi_04": "",
                    "dedi_05": "",
                    "user_define1": "",
                    "user_define2": "",
                    "project_ref_no": ""
                }
            ]
        }
    }
}

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
  }
}

What’s Next