oms打单api
  1. 打单系统
oms打单api
  • 打单系统
    • 获取访问授权
      POST
    • 创建订单
      POST
    • 获取面单接口
      POST
    • 费用试算
      POST
    • 取消订单
      POST
    • 获取发货地址
      GET
    • Scan Form申请接口
      POST
  1. 打单系统

创建订单

POST
/api/svc/createOrder
创建订单接口,请按照请求参数中的说明仔细对照,尤其是电话一栏,虽然我们允许您提交15位甚至更长的电话信息,但是部分渠道商不接受超过15位的电话号码,所以为了您的下单流程顺畅,请自行调整。
我们接口采用垂直下单模式,即您下单后在保持与您的接口通讯时向服务商预报,这样就可以下单后立刻返回所有(包括跟踪号、面单、费用等)信息,然而部分渠道不会立即返回面单或者跟踪号信息,请使用我们的获取面单接口进行获取;此外该模式也可能引起请求超时(因服务商不在大陆境内),您可以再次提交相同的请求,如果上次超时等意外请求已经下单成功,我们会在result字段中包含order_code信息来告诉您这个订单已经成功下单,您可以凭借此订单号去调用获取面单接口完成下单流程,否则因超时或者意外断开连接的请求可以直接下单。

请求参数

Header 参数

Body 参数application/json

示例
{

  "reference_no": "test-002",
  "sm_code": "UPS商业地址01",
  "remark": "测试订单",
  "po_code": "",
  "vat_code": "",
  "parcel_quantity": 1,
  "parcel_declared_value": 12,
  "oa_firstname": "ONT2",
  "oa_company": "AMAZON",
  "oa_street_address1": "1910 E central Ave",
  "oa_street_address2": "",
  "oa_postcode": "92408",
  "oa_state": "CA",
  "oa_city": "San Bernardino",
  "oa_country": "US",
  "oa_doorplate": "",
  "oa_telphone": "8882804331",
  "warehouse_code": "ONT2",
  "signature_service": "SSF",
  "box_list": [
    {
      "box_length": 11,
      "box_width": 11,
      "box_height": 11,
      "box_actual_weight": 10.000
    },
    {
      "box_length": 10,
      "box_width": 10,
      "box_height": 10,
      "box_actual_weight": 8.000
    }
  ],
      "shipper_address": {
        "shipper_name": "Sender Name",
        "shipper_company": "Company Name",
        "shipper_telphone": "88383748",
        "shipper_country": "US",
        "shipper_state_province": "CA",
        "shipper_city": "LA",
        "shipper_address1": "1910 E central Ave",
        "shipper_address2": "",
        "shipper_postal_code": "90001",
        "shipper_doorplate": "",
    }
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/svc/createOrder' \
--header 'Content-Type: application/json' \
--data-raw '{

  "reference_no": "test-002",
  "sm_code": "UPS商业地址01",
  "remark": "测试订单",
  "po_code": "",
  "vat_code": "",
  "parcel_quantity": 1,
  "parcel_declared_value": 12,
  "oa_firstname": "ONT2",
  "oa_company": "AMAZON",
  "oa_street_address1": "1910 E central Ave",
  "oa_street_address2": "",
  "oa_postcode": "92408",
  "oa_state": "CA",
  "oa_city": "San Bernardino",
  "oa_country": "US",
  "oa_doorplate": "",
  "oa_telphone": "8882804331",
  "warehouse_code": "ONT2",
  "signature_service": "SSF",
  "box_list": [
    {
      "box_length": 11,
      "box_width": 11,
      "box_height": 11,
      "box_actual_weight": 10.000
    },
    {
      "box_length": 10,
      "box_width": 10,
      "box_height": 10,
      "box_actual_weight": 8.000
    }
  ],
      "shipper_address": {
        "shipper_name": "Sender Name",
        "shipper_company": "Company Name",
        "shipper_telphone": "88383748",
        "shipper_country": "US",
        "shipper_state_province": "CA",
        "shipper_city": "LA",
        "shipper_address1": "1910 E central Ave",
        "shipper_address2": "",
        "shipper_postal_code": "90001",
        "shipper_doorplate": "",
    }
}'

返回响应

🟢200成功
application/json
Body

示例
{
	"code": 200,
	"result": {
		"reference_no": "Sample_refence",
		"order_code": "J0000000000000000006",
		"order_address_type": "Commercial",
		"order_status": 2,
		"order_sub_status": 0,
		"order_waiting_status": 0,
		"sync_service_status": 1,
		"logistics_err": "",
		"labels": [{
			"tracking_number": "1Z0VV9660322826150",
			"label_url": "http://jinqu-oms-130478380120.cos.ap-shanghai.myqcloud.com/LogisticsOmsService/label2pdf/20240612/570feb202026dbb7c690f12026dc47d3.pdf",
			"file_type": "pdf"
		}],
		"fee": [{
			"ft_code": "shipping",
			"amount": "6.13",
			"currency_code": "USD",
			"ft_name": "运输费"
		}, {
			"ft_code": "FSC",
			"amount": "0.95",
			"currency_code": "USD",
			"ft_name": "燃油附加费"
		}],
		"fee_detail": [{
			"ft_code": "shipping",
			"amount": "6.13",
			"tracking_number": "",
			"box_code": "J0000000000000000006-1",
			"currency_code": "USD",
			"ft_name": "运输费"
		}, {
			"ft_code": "FSC",
			"amount": "0.95",
			"tracking_number": "",
			"box_code": "J0000000000000000006-1",
			"currency_code": "USD",
			"ft_name": "燃油附加费"
		}]
	},
	"msg": "Success"
}
🟠401下单失败
修改于 2024-11-22 11:40:15
上一页
获取访问授权
下一页
获取面单接口
Built with