Create shipment
/shipments
POST
Query Parameters
Name | Type | Description |
---|---|---|
merchant_token | string | Token is created in management system |
Headers
Name | Type | Description |
---|---|---|
Accept | string | application/json |
Content-Type | string | application/json |
Request Body
Name | Type | Description |
---|---|---|
warehouse_code | string | Warehouse code |
customer_code | string | Customer code (if any) |
to_name | string | Recipient |
to_phone | string | Recipient's phone number |
to_province | string | Recipient's province code |
to_district | string | Recipient's district code |
to_ward | string | Recipient's ward code |
to_address | string | Recipient's address |
order_code | string | Order code |
money_collect | string | Total money collect |
description | string | Description |
payment_config | boolean | Set 1 if recipient pays shipping fee Set 0 if sender pays shipping fee |
service_type | string | Main services |
addition_service | array | Additonal services (array additional services ex: ['COD', 'PTT',...]) |
can_check | boolean | Can check package or not |
is_fragile | boolean | Fragile goods |
is_related_product | boolean | Shipment inlcudes products at inventory |
product_name | string | Product name (not required if order does not include related products) |
total_amount | string | Total amount (not required if order does not include related products) |
total_quantity | integer | Total quantity (not required if order does not included related products) |
total_weight | integer | Total weight (not required if order does not include related products) |
items | array | Array products (required if order includes related products) |
items.*.product_sku | string | Related product SKU |
items.*.quantity | integer | Related product quantity |
If is_related_product: true then some fields below are requied: items, items.*.product_sku, items.*.quantity.
If is_related_product: false then some fields below are required: product_name, total_amount, total_quantity, total_weight.
Sample data request
Last updated