POST api/{serverType}/Shipment/Order

Request Information

URI Parameters

Name	Description	Type	Additional information
serverType		string	Required

Body Parameters

OrderRequest

Name	Description	Type	Additional information
Package	包裹信息	PackageForTracking	None.
Config	配置信息	ServiceConfig	None.

Request Formats

application/json, text/json

Sample:

{
  "Package": {
    "PackageSN": "sample string 1",
    "TotalWeightInGram": 2,
    "Packing": "sample string 3",
    "Remark": "sample string 4",
    "Country": "sample string 5",
    "Address1": "sample string 6",
    "Address2": "sample string 7",
    "Address3": "sample string 8",
    "City": "sample string 9",
    "Province": "sample string 10",
    "Receiver": "sample string 11",
    "PhoneNumber": "sample string 12",
    "Email": "sample string 13",
    "PostCode": "sample string 14",
    "DeclareName": "sample string 15",
    "DeclareNameCn": "sample string 16",
    "ShipmentDate": "2025-05-03T15:38:31.8214019+08:00",
    "DeclareValue": 18.0,
    "StorageNo": "sample string 19",
    "BoxInfos": [
      {
        "Name": "sample string 1",
        "WeightInGram": 2,
        "Packing": "sample string 3",
        "ItemInfos": [
          {
            "SKU": "sample string 1",
            "DeclareName": "sample string 2",
            "DeclareNameCn": "sample string 3",
            "DeclareValue": 4.0,
            "WeightInGram": 5.0,
            "Packing": "sample string 6",
            "Quantity": 7,
            "HsCode": "sample string 8",
            "CustomerReferenceNumber": "sample string 9",
            "Brand": "sample string 10",
            "Model": "sample string 11",
            "Material": "sample string 12",
            "Purpose": "sample string 13",
            "SalesUrl": "sample string 14",
            "PackageForTrackingExtraDatas": [
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          },
          {
            "SKU": "sample string 1",
            "DeclareName": "sample string 2",
            "DeclareNameCn": "sample string 3",
            "DeclareValue": 4.0,
            "WeightInGram": 5.0,
            "Packing": "sample string 6",
            "Quantity": 7,
            "HsCode": "sample string 8",
            "CustomerReferenceNumber": "sample string 9",
            "Brand": "sample string 10",
            "Model": "sample string 11",
            "Material": "sample string 12",
            "Purpose": "sample string 13",
            "SalesUrl": "sample string 14",
            "PackageForTrackingExtraDatas": [
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          }
        ],
        "ReferenceId": "sample string 4"
      },
      {
        "Name": "sample string 1",
        "WeightInGram": 2,
        "Packing": "sample string 3",
        "ItemInfos": [
          {
            "SKU": "sample string 1",
            "DeclareName": "sample string 2",
            "DeclareNameCn": "sample string 3",
            "DeclareValue": 4.0,
            "WeightInGram": 5.0,
            "Packing": "sample string 6",
            "Quantity": 7,
            "HsCode": "sample string 8",
            "CustomerReferenceNumber": "sample string 9",
            "Brand": "sample string 10",
            "Model": "sample string 11",
            "Material": "sample string 12",
            "Purpose": "sample string 13",
            "SalesUrl": "sample string 14",
            "PackageForTrackingExtraDatas": [
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          },
          {
            "SKU": "sample string 1",
            "DeclareName": "sample string 2",
            "DeclareNameCn": "sample string 3",
            "DeclareValue": 4.0,
            "WeightInGram": 5.0,
            "Packing": "sample string 6",
            "Quantity": 7,
            "HsCode": "sample string 8",
            "CustomerReferenceNumber": "sample string 9",
            "Brand": "sample string 10",
            "Model": "sample string 11",
            "Material": "sample string 12",
            "Purpose": "sample string 13",
            "SalesUrl": "sample string 14",
            "PackageForTrackingExtraDatas": [
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              },
              {
                "Key": "sample string 1",
                "Value": "sample string 2"
              }
            ]
          }
        ],
        "ReferenceId": "sample string 4"
      }
    ],
    "ReferenceNumber": "sample string 20",
    "RetryGetLabelOrTrackingNumberKey": "sample string 21",
    "AmazonOrder": {
      "ShipmentId": "sample string 1",
      "ReferenceId": "sample string 2"
    },
    "TaxNumber": "sample string 22",
    "VatDeclaretion": {
      "SenderEoriCode": "sample string 1",
      "ImporterEoriCode": "sample string 2",
      "ImporterVatCode": "sample string 3",
      "SenderAddress": {
        "Name": "sample string 1",
        "CompanyName": "sample string 2",
        "PostCode": "sample string 3",
        "Phone": "sample string 4",
        "Mobile": "sample string 5",
        "Country": "sample string 6",
        "City": "sample string 7",
        "Province": "sample string 8",
        "Email": "sample string 9",
        "Address1": "sample string 10",
        "Address2": "sample string 11",
        "Address3": "sample string 12",
        "CompanyCode": "sample string 13",
        "ClientCode": "sample string 14"
      },
      "ImporterAddress": {
        "Name": "sample string 1",
        "CompanyName": "sample string 2",
        "PostCode": "sample string 3",
        "Phone": "sample string 4",
        "Mobile": "sample string 5",
        "Country": "sample string 6",
        "City": "sample string 7",
        "Province": "sample string 8",
        "Email": "sample string 9",
        "Address1": "sample string 10",
        "Address2": "sample string 11",
        "Address3": "sample string 12",
        "CompanyCode": "sample string 13",
        "ClientCode": "sample string 14"
      },
      "CodAmount": 4.0
    },
    "HouseNumber": "sample string 23",
    "SalesPlatform": "sample string 24",
    "PackageForTrackingExtraDatas": [
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      }
    ]
  },
  "Config": {
    "ServiceName": "sample string 1",
    "LoginName": "sample string 2",
    "Password": "sample string 3",
    "ServiceUrl": "sample string 4",
    "ShipmentAddress": {
      "Name": "sample string 1",
      "CompanyName": "sample string 2",
      "PostCode": "sample string 3",
      "Phone": "sample string 4",
      "Mobile": "sample string 5",
      "Country": "sample string 6",
      "City": "sample string 7",
      "Province": "sample string 8",
      "Email": "sample string 9",
      "Address1": "sample string 10",
      "Address2": "sample string 11",
      "Address3": "sample string 12",
      "CompanyCode": "sample string 13",
      "ClientCode": "sample string 14"
    },
    "BillingAddress": {
      "Name": "sample string 1",
      "CompanyName": "sample string 2",
      "PostCode": "sample string 3",
      "Phone": "sample string 4",
      "Mobile": "sample string 5",
      "Country": "sample string 6",
      "City": "sample string 7",
      "Province": "sample string 8",
      "Email": "sample string 9",
      "Address1": "sample string 10",
      "Address2": "sample string 11",
      "Address3": "sample string 12",
      "CompanyCode": "sample string 13",
      "ClientCode": "sample string 14"
    },
    "ExtraConfigs": [
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Key": "sample string 1",
        "Value": "sample string 2"
      }
    ],
    "AdditionalServicesInfo": {
      "PalletCount": 1,
      "NeedLiftgate": true
    },
    "PlatformClientId": "sample string 5"
  }
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'OrderRequest'.

Response Information

Resource Description

ServiceResponse

Name	Description	Type	Additional information
IsSuccess	状态	boolean	None.
Message	状态信息	string	None.
LabelResponse	标签数据	Collection of Label	None.
InvoiceResponse	发票数据	Invoice	None.
ErrorType	错误类型	string	None.
SupplierErrorCode	第三方供应商错误类型	string	None.
SupplierOrderTimeInMillisecond		decimal number	None.
SupplierOrderInfo		SupplierOrderInfo	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccess": true,
  "Message": "sample string 2",
  "LabelResponse": [
    {
      "PackageSN": "sample string 1",
      "TrackingNumber": "sample string 2",
      "UrlPath": "sample string 3",
      "Data": "QEA=",
      "LabelFormatType": 0,
      "Remark": "sample string 4",
      "SupplierOrderInfo": "sample string 5"
    },
    {
      "PackageSN": "sample string 1",
      "TrackingNumber": "sample string 2",
      "UrlPath": "sample string 3",
      "Data": "QEA=",
      "LabelFormatType": 0,
      "Remark": "sample string 4",
      "SupplierOrderInfo": "sample string 5"
    }
  ],
  "InvoiceResponse": {
    "Data": "QEA=",
    "InvoiceFormatType": 0,
    "UrlPath": "sample string 1",
    "Remark": "sample string 2"
  },
  "ErrorType": "sample string 3",
  "SupplierErrorCode": "sample string 4",
  "SupplierOrderTimeInMillisecond": 5.1,
  "SupplierOrderInfo": {
    "InternalOrderNumber": "sample string 1",
    "RetryGetLabelOrTrackingNumberKey": "sample string 2"
  }
}