Create Sales Order B2B

Last Updated: 13/12/2022

Create Sales Order B2B

Shipper API gives interface access to our clients for creating Sales Order API from their own system to Shipper Warehouse Management System. It applies for B2B type of Business if the the source order is using your ERP system.

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

POST Create Sales Order B2B

Method	Endpoint
POST	/v3/fulfillment/outbound/wms

📘
Note

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

Body Request Parameter

Field	Data Type	Description	Note
warehouse_id	String(20)	Warehouse ID given by Shipper Example: WH-AA99	Mandatory
customer_id	String(50)	Customer ID given by Shipper Example: HJ	Mandatory
order_type	String(20)	Order type Example: RT	Mandatory Valid value: RT - Return CSO - Customer Sales Order (Normal Order) TT - Inter-warehouse Transfer CD - Cross dock
doc_no	String(20)	Shipment order number Example: TEST3	Mandatory No special character
order_time	yyyy-MM-ddTHH:mm:ssZ	Sales Order date Example: 2021-05-07T00:00:00Z	Mandatory
consignee_id	String(50)	Consignee ID example: ERP	Optional
consignee_name	String(50)	Receiver Name Example: Naufal	Mandatory
consignee_tel	String(30)	Receiver Phone Example: 0813456789	Mandatory
consignee_mail	String(100)	Receiver Email Address Example: [email protected]	Mandatory Must be on email format: [email protected]
consignee_zip	Integer	Consignee ZIP Code Example: 12345	Mandatory Must have 5 characters
consignee_address	String(200)	Consignee Full Address such as street no, district, city, province Example: Jl. Open Api no 5, Tanah Abang, Jakarta Pusat, DKI Jakarta	Mandatory
consignee_state	String(30)	Consignee State Example: ID	Mandatory
consignee_province	String(50)	Consignee Province Example: East Java	Mandatory
consignee_city	String(128)	Consignee City Example: Surabaya	Mandatory
delivery_no	Integer(30)	AWB No Example: 123129839”	Optional
carrier_id	String(30)	Expedition Code Example: SicepatID	Mandatory
carrier_name	String(200)	Courier Name / Expedition Name	Optional
priority	String(1)	Order Priority	Optional
notes	Text(500)	Remarks Example: this is order for client xxx	Optional
cross_dock_flag	String(1)	Cross Dock Flag Default to Y if order_type is filled with CD	Optional
DETAILS
line_no	Integer	Line No Example: 123123	Mandatory
sku	String(30)	SKU Code Example: SKU-AAAA	Mandatory
qty_ordered	Integer	Order QTY Example: 2	Mandatory Please use the smallest UoM. 1 SKU Code able to Map to Multiple UoM at WMS. Auto Convert from WMS
price	Decimal(24,7)	Goods Price Example: 100.00	Optional
mfg_date	yyyy-MM-dd	Goods Manufacturing Date Example: 2021-01-01	Optional
exp_date	yyyy-MM-dd	Goods Expired Date Example: 2021-01-01	Optional
batch_no	String(100)	Goods Batch No Example: 182739812	Optional
serial_no	String(100)	Goods Serial No Example: 12381782	Optional
receipt_date	yyyy-MM-dd	Goods Receipt Date Example: 2021-01-01	Optional
stock_condition	String	Goods Stock Condition Y: DAMAGED condition N: GOOD condition	Optional If the order type is RT, only allow Y, which is DAMAGED condition.
total_gross_weight	Decimal(18,8)	Total Gross Weight Example: 20.0	Optional
total_net_weight	Decimal(18,8)	Total Net Weight Example: 20.0	Optional
total_cubic	Decimal(18,8)	Total Cubic Example: 20.0	Optional

Sample Body Request

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

{
    "data": {
        "outbound": {
            "warehouse_id": "WH-TGR04",
            "customer_id": "HJ",
            "order_type": "RT",
            "doc_no": "TEST-OUTBOUND-WMS-3",
            "order_time": "2021-05-07T00:00:00Z",
            "consignee_address": " Kampus IPB, Jl. Raya Dramaga, Babakan, Kec. Dramaga, Kota Bogor, Jawa Barat 16680",
            "consignee_mail": "[email protected]",
            "consignee_name": "YOGA",
            "consignee_tel": "0822323223",
            "carrier_id": "SicepatID",
            "consignee_zip": 16680,            
            "details": [
                {
                    "line_no": 1,
                    "qty_ordered": 10,
                    "sku": "1-MACBOOK"
                }
            ]
        }
    }
}

{
    "data": {
        "outbound": {
            "warehouse_id": "WH-TGR04",
            "customer_id": "HJ",
            "order_type": "RT",
            "doc_no": "TEST-OUTBOUND-WMS-3",
            "notes": "notes",
            "order_time": "2021-05-07T00:00:00Z",
            "priority": "H",
            "carrier_id": "SicepatID",
            "carrier_name": "Sicepat",
            "consignee_address": " Kampus IPB, Jl. Raya Dramaga, Babakan, Kec. Dramaga, Kota Bogor, Jawa Barat 16680",
            "consignee_id": "ERP",
            "consignee_mail": "[email protected]",
            "consignee_name": "YOGA",
            "consignee_tel": "0822323223",
            "consignee_zip": 16680,            
            "delivery_no": "1234",
            "cross_dock_flag": "Y",
            "details": [
                {
                    "batch_no": "1",
                    "exp_date": "2021-05-27",
                    "line_no": 1,
                    "mfg_date": "2021-05-27",
                    "price": 10000,
                    "qty_ordered": 10,
                    "receipt_date": "2021-05-27",
                    "serial_no": "SERIAL-1-X",
                    "sku": "1-MACBOOK",
                    "stock_condition": "Y",
                    "project_ref_no":"123124", 
                    "total_gross_weight":99.0,
                    "total_net_weight":99.0,
                    "total_cubic":99.0
                }
            ]
        }
    }
}

Sample Response

{
  "metadata": {
    "path": "/v3/fulfillment/outbound/wms",
    "http_status_code": 201,
    "http_status": "Created",
    "timestamp": 1652326659
  },
  "data": {
    "request_id": "hwoutboundwms.2022.05.12033739.067611"
  }
}

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

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

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

Status	Reason
201	Create sales order B2B 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.

Updated 1 day ago