Sync shipment

Path: /go/packageOpenApiWeb/OpenApiV2/SyncPlatformShip

The merchant platform pushes shipment information to Xcotton. Once processed, the policy becomes effective and claims open. Works for both shipping protection and extended warranty.

For the full field reference see API reference · SyncPlatformShip.

Notes:

• shipOtherInfo is a flat ShipAddress (country / province / city / postalCode / linkName, …) with no shipToAddress wrapper.
• Every shipment entry must carry shipId, actualShipSendTime, and shipTrackNumber, plus at least one of shipCompany / shipCompanyCode; actualShipSendTime uses RFC 3339.
• itemList: optional for shipping protection (omitting means whole-order shipment); required for extended warranty. To target a specific warranty plan, pass ppVariant (Plan ID required).
• The response JSON key is orderId (not OrderId).
• The response keeps both singular and plural compatibility keys — shipId / shipIds, disXmhShopOrderShipId / disXmhShopOrderShipIds — and their values are always arrays.

Request example:

{
  "orderId": "1744082334",
  "subOrderId": "",
  "shipInfoList": [
    {
      "shipId": "1744613515",
      "shipPrice": "6.00",
      "actualShipSendTime": "2025-04-07T05:37:10.000Z",
      "shipCompany": "SF",
      "shipCompanyCode": "SF",
      "shipTrackNumber": "1744613515",
      "shipStateString": "SHIPED",
      "shipOtherInfo": {
        "country": "China",
        "countryCode": "CN",
        "province": "Zhejiang",
        "provinceCode": "",
        "city": "Hangzhou",
        "cityCode": "",
        "district": "",
        "street": "",
        "address": "",
        "postalCode": "",
        "name": "",
        "firstName": "",
        "lastName": "",
        "companyName": "",
        "mobile": "",
        "cert": "",
        "email": "",
        "linkName": "",
        "linkMobile": ""
      },
      "itemList": [
        {
          "itemId": "97760109-16ad-40c9-9385-caba381a26aa",
          "variantId": "",
          "skuId": "SKU001",
          "orderGoodsId": "",
          "productId": "",
          "itemName": "Durable Concrete Shirt",
          "itemDesc": "",
          "itemState": 0,
          "itemTag": "",
          "itemType": "",
          "itemOtherInfoJson": "",
          "ItemPicInfoMain": null,
          "ItemPicInfoOther": null,
          "currency": "USD",
          "unitNum": "2",
          "isPackageItem": false,
          "isPPItem": false,
          "unitPrice": "100.00",
          "preferentialPrice": "50.00",
          "subTotalPrice": "",
          "subTotalTaxPrice": "",
          "taxPrice": "",
          "totalPrice": "200.00",
          "totalPayPrice": "150.00",
          "Properties": null,
          "ppVariant": null,
          "serviceOrderIds": null
        }
      ]
    }
  ]
}

Response example:

{
    "errCode": 0,
    "errMsg": "success",
    "data": {
        "orderId": "order-005",
        "shipIds": ["ship-005-3"],
        "disXmhShopOrderShipIds": ["xsship-00222280000000009372657428"]
    }
 }