Update Sales Order B2C

Shipper API gives interface access to our clients for updating Sales Order API from their own system to Shipper Order Management System. It applies for B2C type of Business if you have multiple channel for source orders.

Authorizations : X-API-Key_Header

Request Body Schema : application/json

PUT Update Sales Order

FieldEndpoint
PUT /v3/fulfillment/outbound/oms

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(20)

Warehouse code assigned

Example: WH-TGR04

Mandatory

seller_nick

String(20)

Seller Nick Name

Please Fill with Empty String

so_number(60)

String

Sales Order Number

Example: SALES-OUTBOUND-1X

Mandatory

order_identification_code

Integer

Public Order Identification 1: Pending Shipment

Mandatory

internal_order_status

String(45)

Client’s ERP order status

Mandatory

express_code(100)

String

Courier Code

Optional

tenant_name

String(200)

Client Name

Mandatory

consignee

String(300)

Consignee Name

Mandatory

consignee_phone

String(300)

Consignee Phone

Mandatory

mobile

String(300)

Consignee Mobile Phone

Please Fill with Empty String

consignee_email

String(200)

Consignee Email Address

Mandatory

consignee_full_address

String(800)

Consignee Full Address such as street no, district, city, province

Mandatory

consignee_state

String(30)

Consignee State

Mandatory

consignee_province

String(50)

Consignee Province

Mandatory

consignee_city

String(50)

Consignee City

Mandatory

area

String(100)

Area Name

Please Fill with Empty String

town

String(30)

Town Name

Please Fill with Empty String

zipcode

String(20)

Consignee ZIP Code

Mandatory

consignee_doc_type

Integer

Consignee ID Type,

1: ID card,
2: Passport,
3: Other

Optional

consignee_doc_no

String(255)

Consignee ID number

Optional

notice_send_date

yyyy-MM-ddTHH:mm:ssZ

Sales Order Appointment Date

Optional

trans_priority

Integer

Transfer order priority

Optional

seller_flag

String(10)

Platform order flag

Optional

buyer_remark

String(500)

Buyer Remarks

Mandatory

seller_remark

String(200)

Seller Remarks

Mandatory

order_price

Decimal(10,2)

Sales Order Price

Mandatory

pre_tax_price

Decimal(10,2)

Pre-tax amount

Optional

tax_price

Decimal(10,2)

Withholding tax

Please Fill with 0 (Zero)

discount_price

Decimal(10,2)

Discounted price

Please Fill with 0 (Zero)

postage

Decimal(10,2)

Delivery Cost from the courier or 3PL

Mandatory

cod_price

Decimal(10,2)

Cash on Delivery for the sales order

Mandatory

order_time

yyyy-MM-ddTHH:mm:ssZ

Sales Order Created Date Time

Mandatory

payment_time

yyyy-MM-ddTHH:mm:ssZ

Payment time

Please Fill with Empty String

invoice_type

Integer

Invoice Type,

0: No Invoice,
1: Ordinary Invoice,
2: VAT Invoice

Please Fill with 0 (Zero)

invoice_title

String(200)

Invoice Title

Please Fill with Empty String

invoice_content

String(300)

Invoice content

Please Fill with Empty String

invoice_amount

Decimal

Invoice amount(10,2)

Please Fill with 0 (Zero)

payment_type

Integer

Payment Type,

0: Non-Cash on Delivery,
1: Cash on Delivery

Mandatory

payment_way

String(20)

Payment Method Code

Mandatory

distribution_status

String

Whether is it a distribution order

Mandatory

plat_last_changed

yyyy-MM-ddTHH:mm:ssZ

Last update time of order from client’s ERP

Mandatory

distribution_mode

Integer

Distribution mode,

1: Consignment,
2: Distribution

Please Fill with 0 (Zero)

distribution_name

String(255)

Distributor name

Please Fill with Empty String

express_no

String(60)

AWB Number

Optional

payment_number

String(40)

Payment serial number

Please Fill with Empty String

gross_weight

Decimal(10,2)

Gross weight

Please Fill with 0 (Zero)

paint_marker

String

Big head pen

Please Fill with Empty String

express_print_data

-

-

Please Fill with Empty String

DETAILS

 

 

oid

String(100)

Platform sub-transaction number

Please Fill with Empty String

title

String(30)

Title of commodities on the platform

Please Fill with Empty String

sku

String(40)

SKU Code. 1 SKU Code map to 1 UoM. Example 1 Carton and 1 Pack of the same Goods will use different SKU Code at WMS and OMS

Mandatory

order_qty

Integer

Order Quantity. 1 SKU Code map to 1 UoM

Mandatory

goods_price

Decimal(10,2)

Goods Price

Please Fill with 0 (Zero)

avg_money

Decimal(10,2)

Average Money

Please Fill with 0 (Zero)

tax_price

Decimal(10,2)

Tax for The Goods

Please Fill with 0 (Zero)

discount_price

Decimal(10,2)

Discound Amount

Please Fill with 0 (Zero)

return_status

Integer

Refund Status

Please Fill with 0 (Zero)

sku_properties

String

Commodity specifications

Please Fill with Empty String

net_weight

Decimal

Net weight

Please Fill with 0 (Zero)

Sample Body Request

{
  "data": {
    "outbound": {
      "warehouse_id": "MDN",
      "customer_id": "HJ",
      "seller_nick": "Yoga",
      "so_number": "TEST-OUTBOUND-8-X",
      "order_identification_code": 0,
      "internal_order_status": "Sent to Delivery",
      "express_code": "JNE",
      "tenant_name": "HAUS JAKARTA",
      "consignee": "Nama Consignee",
      "consignee_phone": "08123456789",
      "consignee_mobile": "08123456789",
      "consignee_email": "[email protected]",
      "consignee_full_address": "Jl Ahmad Yani",
      "consignee_state": "Indonesia",
      "consignee_province": "DKI Jakarta",
      "consignee_city": "Jakarta",
      "area": "string",
      "town": "string",
      "zip_code": "12345",
      "consignee_doc_type": 0,
      "consignee_doc_no": "string",
      "notice_send_date": "string",
      "trans_priority": 0,
      "seller_flag": "string",
      "buyer_remark": "testing",
      "seller_remark": "testing",
      "order_price": 1000000,
      "pre_tax_price": 0,
      "tax_price": 0,
      "discount_price": 0,
      "postage": 10,
      "cod_price": 1000000,
      "order_time": "2021-04-22T12:34:56Z",
      "payment_time": "2021-11-02T15:04:05Z",
      "invoice_type": 0,
      "invoice_title": "string",
      "invoice_content": "string",
      "invoice_amount": 0,
      "payment_type": 1,
      "payment_way": "PaymentCode",
      "plat_last_changed": "2021-11-02T15:04:05Z",
      "distribution_mode": 0,
      "distribution_name": "string",
      "distribution_status": 1,
      "express_no": "AWBJNE001",
      "payment_number": "string",
      "gross_weight": 0,
      "paint_maker": "string",
      "express_print_data": "string",
      "details": [
        {
          "oid": "string",
          "title": "string",
          "sku": "2-MACBOOK",
          "order_qty": 5,
          "goods_price": 0,
          "avg_money": 0,
          "tax_price": 0,
          "discount_price": 0,
          "refund_status": 0,
          "sku_properties": "string",
          "net_weight": 0
        }
      ]
    }
  }
}

Sample Response

{
    "metadata": {
        "path": "/v3/fulfillment/outbound/oms",
        "http_status_code": 201,
        "http_status": "Created",
        "timestamp": 1637652372
    },
    "data": {
        "request_id": "outbound.2021.11.23072612.183239"
    }
}
{
    "metadata": {
        "path": "/v3/fulfillment/outbound/oms",
        "http_status_code": 400,
        "http_status": "Bad Request",
        "errors": [
            {
                "code": 810,
                "message": "Invalid Input. Please Validate Your Input."
            }
        ],
        "timestamp": 1637652448
    }
}
{
    "metadata": {
        "path": "/v3/fulfillment/outbound/oms",
        "http_status_code": 401,
        "http_status": "Unauthorized",
        "errors": [
            {
                "code": 10001,
                "message": "Unauthorized Access. You are not authorized to access this resource."
            }
        ],
        "timestamp": 1637652420
    }
}
{
   "metadata": {
      "path": "/v3/fulfillment/supplier",
      "http_status_code": 500,
      "http_status": "Internal Server Error",
      "errors": [
        {
          "code": 803,
          "message": "Internal Server error."
        }
      ],
      "timestamp": 1637555484
   }
}

What’s Next