4PX Open Platform

https://open.4px.com/v2/doc
Admin
A platform offering APIs for managing direct shipping logistics, including order creation, tracking,...
Tokens:2,362
Snippets:15
Trust Score:9.7
Update:9 months ago
Show doc for...
Tokens:
Raw
### Logistics Product API

Source: https://open.4px.com/v2/doc/index

Endpoint for retrieving the list of available logistics products.

```APIDOC
## GET /ds.xms.logistics_product.getlist

### Description
Retrieves a list of available logistics products.

### Method
GET

### Endpoint
/ds.xms.logistics_product.getlist

### Parameters
#### Query Parameters
- **param1** (type) - Required/Optional - Description

### Response
#### Success Response (200)
- **field1** (type) - Description

#### Response Example
{
  "example": "response body"
}
```

--------------------------------

### Label API

Source: https://open.4px.com/v2/doc/index

Endpoints for generating and retrieving labels.

```APIDOC
## POST /ds.xms.label.get

### Description
Creates a label.

### Method
POST

### Endpoint
/ds.xms.label.get

### Parameters
#### Request Body
- **field1** (type) - Required/Optional - Description

### Response
#### Success Response (200)
- **field1** (type) - Description

#### Response Example
{
  "example": "response body"
}

## GET /ds.xms.label.getlist

### Description
Retrieves a list of labels.

### Method
GET

### Endpoint
/ds.xms.label.getlist

### Parameters
#### Query Parameters
- **param1** (type) - Required/Optional - Description

### Response
#### Success Response (200)
- **field1** (type) - Description

#### Response Example
{
  "example": "response body"
}
```

--------------------------------

### Tracking API

Source: https://open.4px.com/v2/doc/index

Endpoint for retrieving shipment tracking information.

```APIDOC
## GET /tr.order.tracking.get

### Description
Retrieves the tracking information for an order.

### Method
GET

### Endpoint
/tr.order.tracking.get

### Parameters
#### Query Parameters
- **param1** (type) - Required/Optional - Description

### Response
#### Success Response (200)
- **field1** (type) - Description

#### Response Example
{
  "example": "response body"
}
```

--------------------------------

### Collection Appointment API

Source: https://open.4px.com/v2/doc/index

Endpoints for managing collection appointments and reservations.

```APIDOC
## POST /ds.xms.api.collect.create.big

### Description
Adds a reservation package.

### Method
POST

### Endpoint
/ds.xms.api.collect.create.big

### Parameters
#### Request Body
- **field1** (type) - Required/Optional - Description

### Response
#### Success Response (200)
- **field1** (type) - Description

#### Response Example
{
  "example": "response body"
}

## DELETE /ds.xms.api.collect.cancel.big

### Description
Cancels a reservation package.

### Method
DELETE

### Endpoint
/ds.xms.api.collect.cancel.big

### Parameters
#### Request Body
- **field1** (type) - Required/Optional - Description

### Response
#### Success Response (200)
- **field1** (type) - Description

#### Response Example
{
  "example": "response body"
}

## POST /ds.xms.api.collect.print.big

### Description
Prints package labels for a reservation.

### Method
POST

### Endpoint
/ds.xms.api.collect.print.big

### Parameters
#### Request Body
- **field1** (type) - Required/Optional - Description

### Response
#### Success Response (200)
- **field1** (type) - Description

#### Response Example
{
  "example": "response body"
}

## POST /ds.xms.api.collect.create.order

### Description
Creates a collection appointment form.

### Method
POST

### Endpoint
/ds.xms.api.collect.create.order

### Parameters
#### Request Body
- **field1** (type) - Required/Optional - Description

### Response
#### Success Response (200)
- **field1** (type) - Description

#### Response Example
{
  "example": "response body"
}

## DELETE /ds.xms.api.collect.cancel.order

### Description
Cancels a reservation.

### Method
DELETE

### Endpoint
/ds.xms.api.collect.cancel.order

### Parameters
#### Request Body
- **field1** (type) - Required/Optional - Description

### Response
#### Success Response (200)
- **field1** (type) - Description

#### Response Example
{
  "example": "response body"
}

## POST /ds.xms.api.collect.print.order

### Description
Prints a reservation form.

### Method
POST

### Endpoint
/ds.xms.api.collect.print.order

### Parameters
#### Request Body
- **field1** (type) - Required/Optional - Description

### Response
#### Success Response (200)
- **field1** (type) - Description

#### Response Example
{
  "example": "response body"
}
```

--------------------------------

### Estimated Cost API

Source: https://open.4px.com/v2/doc/index

Endpoint for querying estimated costs.

```APIDOC
## GET /ds.xms.estimated_cost.get

### Description
Queries the estimated cost for a service.

### Method
GET

### Endpoint
/ds.xms.estimated_cost.get

### Parameters
#### Query Parameters
- **param1** (type) - Required/Optional - Description

### Response
#### Success Response (200)
- **field1** (type) - Description

#### Response Example
{
  "example": "response body"
}
```

--------------------------------

### Direct Shipping Order API

Source: https://open.4px.com/v2/doc/index

Endpoints related to the creation, querying, updating, and cancellation of direct shipping orders.

```APIDOC
## POST /ds.xms.order.create

### Description
Creates a direct shipping order.

### Method
POST

### Endpoint
/ds.xms.order.create

### Parameters
#### Request Body
- **field1** (type) - Required/Optional - Description

### Request Example
{
  "example": "request body"
}

### Response
#### Success Response (200)
- **field1** (type) - Description

#### Response Example
{
  "example": "response body"
}

## GET /ds.xms.order.get

### Description
Queries direct shipping consignment orders. Supports single query by ticket number or batch query by time and status.

### Method
GET

### Endpoint
/ds.xms.order.get

### Parameters
#### Query Parameters
- **param1** (type) - Required/Optional - Description

### Response
#### Success Response (200)
- **field1** (type) - Description

#### Response Example
{
  "example": "response body"
}

## PUT /ds.xms.order.updateweight

### Description
Updates the weight of a direct shipping consignment order.

### Method
PUT

### Endpoint
/ds.xms.order.updateweight

### Parameters
#### Request Body
- **field1** (type) - Required/Optional - Description

### Response
#### Success Response (200)
- **field1** (type) - Description

#### Response Example
{
  "example": "response body"
}

## DELETE /ds.xms.order.cancel

### Description
Cancels a direct shipping consignment order.

### Method
DELETE

### Endpoint
/ds.xms.order.cancel

### Parameters
#### Request Body
- **field1** (type) - Required/Optional - Description

### Response
#### Success Response (200)
- **field1** (type) - Description

#### Response Example
{
  "example": "response body"
}

## POST /ds.xms.order.hold

### Description
Applies for holding or cancelling a hold on an order. Successful interceptions are managed as problems.

### Method
POST

### Endpoint
/ds.xms.order.hold

### Parameters
#### Request Body
- **field1** (type) - Required/Optional - Description

### Response
#### Success Response (200)
- **field1** (type) - Description

#### Response Example
{
  "example": "response body"
}

## PUT /ds.xms.order.updateByLabel

### Description
Updates the service provider order number and label URL. Applies when tracking/label info is issued separately after creating a logistics order. Valid in pre-booking status.

### Method
PUT

### Endpoint
/ds.xms.order.updateByLabel

### Parameters
#### Request Body
- **field1** (type) - Required/Optional - Description

### Response
#### Success Response (200)
- **field1** (type) - Description

#### Response Example
{
  "example": "response body"
}

## POST /ds.xms.order.getFreight

### Description
Queries order fee information.

### Method
POST

### Endpoint
/ds.xms.order.getFreight

### Parameters
#### Request Body
- **field1** (type) - Required/Optional - Description

### Response
#### Success Response (200)
- **field1** (type) - Description

#### Response Example
{
  "example": "response body"
}
```
Tokens:
Raw