---
url: >-
  https://acquirer-api-docs-v4-en.pingpongx.com/en/notes/checkout/api/LogisticsUpload/index.md
description: >-
  The LogisticsUpload API is used to upload order logistics information. It is
  suitable for scenarios where merchants need to update order logistics status
  after users complete payment on e-commerce platforms. Key features include
  adding or updating logistics details, with main parameters including order ID,
  logistics company, and tracking number.
---
# LogisticsUpload

```apidef
endpoint: POST /v4/logistics/upload
name: LogisticsUpload
summary: Upload logistics information
tags: Checkout, Upload
```

The LogisticsUpload API is used to upload order logistics information. It is suitable for scenarios where merchants need to update order logistics status after users complete payment on e-commerce platforms. Key features include adding or updating logistics details, with main parameters including order ID, logistics company, and tracking number.

## Request Parameters

| Parameter | Type | Required | Description |
|--------|------|------|------|
| accId | string | M | Unique identifier for the store, which will appear in the response message after creation; inputting it means modifying the data |
| clientId | string | M | PingPong Merchant ID |
| signType | string | M | Supports MD5 , SHA256; for details, see the Signature Specification: /en/notes/guide/sign/ section of this document |
| sign | string | M | Signature; for details, see the Signature Specification: /en/notes/guide/sign/ section of this document. All parameters participate in the signature |
| version | string | M | Version number, currently fixed at 1.0, may be adjusted with changes to the interface in the future |
| bizContent | string | M | Collection of request parameters, with no limit on maximum length. Except for common request parameters, all other request parameters must be passed within this parameter, format: JSON string |
| └─ merchantTransactionId | string | M | Merchant website order number |
| └─ trackingNumber | string | M | Logistics tracking number |
| └─ logisticsCompany | string | M | Logistics company |
| └─ logisticsCompanyUrl | string | M | Logistics query website URL |

### Request Example

```json
{
  "accId": "2023042011040310224447",
  "bizContent": "{\"trackingNumber\":\"SF2314234131314\",\"merchantTransactionId\":\"PMT-2S7RR3K4LQ1715047351210\",\"logisticsCompany\":\"顺丰\",\"logisticsCompanyUrl\":\"https://test-acquirerpay.pingpongx.com/qa/notify\"}",
  "clientId": "2023042011040310224",
  "sign": "FD92418286FF6EDD5F7D28063567FABFEBBC48297E1D410AD8FED19193B64D40",
  "signType": "SHA256",
  "version": "1.0"
}
```

## Response Parameters

| Parameter | Type | Description |
|--------|------|------|
| accId | string | Unique store identifier |
| clientId | string | PingPong merchant number |
| signType | string | Supports MD5 , SHA256; for details, see the Signature Specification: /en/notes/guide/sign/ section of this document |
| sign | string | Signature; for details, see the Signature Specification: /en/notes/guide/sign/ section of this document. All parameters participate in the signature |
| bizContent | string | Business response parameters |
| └─ merchantTransactionId | string | Merchant Website Order Number |
| └─ trackingNumber | string | Logistics Number |
| └─ logisticsCompany | string | Logistics Company |
| └─ logisticsCompanyUrl | string | Logistics Inquiry Address |
| └─ result | string | YES/NO |
| └─ reason | string | Reason for Upload Failure |

### Response Example

```json
{
  "accId": "2023042011040310224447",
  "bizContent": "{\"result\":\"YES\",\"logisticsCompanyUrl\":\"https://test-acquirerpay.pingpongx.com/qa/notify\",\"logisticsCompany\":\"顺丰\",\"merchantTransactionId\":\"PMT-2S7RR3K4LQ1715047351210\",\"trackingNumber\":\"SF2314234131314\"}",
  "clientId": "2023042011040310224",
  "sign": "97EDF744606E4E393A6C198D7A8AC65648AF58C0E3E6D8A7E918843C747DA4F8",
  "signType": "SHA256"
}
```