iMile Developer's Kit

https://imiledeveloperskit.docs.apiary.io
Admin
The iMile Developer's Kit provides APIs for partners to create dropship, reverse, and fulfillment...
Tokens:597,347
Snippets:2,284
Trust Score:9.9
Update:10 months ago
Show doc for...
Tokens:
Raw
### Introduction and Environment

Source: https://imiledeveloperskit.docs.apiary.io/reference/0/tracking-orders/tracking-bulk-orders

General information about the iMile Developer's Kit, including how to get started and the available testing and production environments.

```APIDOC
## iMile Developer's Kit

### Introduction
Greetings, Thank you for choosing `iMile` as your `delivery partner`. You can use our APIs to create dropship orders, reverse orders and fulfillment orders, Track your order and more.

Please contact iMile team to get your `CustomerID` and `APIKey` to get started.

### Environments
**Testing Environment**: `https://openapi.52imile.cn`
**Production Environment**: `https://openapi.imile.com`
```

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

### iMile API Introduction

Source: https://imiledeveloperskit.docs.apiary.io/reference/0/create-order/create-api

Introduction to the iMile Developer's Kit APIs. Provides information on how to get started, important parameters, and environment details.

```APIDOC
## iMile Developer's Kit API Documentation

### Description
Greetings, Thank you for choosing `iMile` as your `delivery partner`. You can use our APIs to create dropship orders, reverse orders and fulfillment orders, Track your order and more.
Please contact iMile team to get your `CustomerID` and `APIKey` to get started.

### Notes
* If required field is missing in the request, or the length exceeds limitation, the status field in the response will be `error`.
* Please ignore unknown fields when deserialize response to JSON.
* In this API, the response http status code is always `200` as long as the request is processed. The structure of the response is also fixed, always a JSON.
* In some special scenario, API will response other http status code instead of `200`. For example when the server is too busy to process the request, it will response `500`. In such case, the response body will be empty. Please ignore the response body when http status code is not `200`, and suggest to retry later.

### Environments
**Testing Environment** : `https://openapi.52imile.cn`
**Production Environment** : `https://openapi.imile.com`

### Important API Parameters

| Parameter      | Vital | Type   | Description                                                                 |
|----------------|-------|--------|-----------------------------------------------------------------------------|
| customerID     | Y     | String | Client code (provided by the IMILE platform)                                |
| format         | Y     | String | Data format, default : `json`                                               |
| accessToken    | Y     | String | Temporary token, except the interface for obtaining the token, all other interfaces are required |
| version        | Y     | String | Interface version number                                                    |
| signMethod     | Y     | String | Encryption, `SHA256` or `MD5`, Default: `SimpleKey`                         |
| timestamp      | Y     | String | Timestamp (the current number of milliseconds in the system, consistent with timeZone) |
| timeZone       | Y     | String | The caller's system time zone (+8/GMT+8), (+4/GMT+4)                        |
| param          | Y     | String | Request parameters, different parameters for different interfaces             |

* Always use the pickup services when creating an order for a timely collection, faster processing, and improved customer convenience.
```

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

### Introduction to iMile APIs

Source: https://imiledeveloperskit.docs.apiary.io/reference/0/create-order/create-order-version-2-api

This section provides an overview of the iMile APIs, including how to get started, important parameters, and environmental details.

```APIDOC
## Introduction to iMile APIs

Greetings, Thank you for choosing `iMile` as your `delivery partner`. You can use our APIs to create dropship orders, reverse orders and fulfillment orders, Track your order and more.

Please contact iMile team to get your `CustomerID` and `APIKey` to get started.

### Important API Parameters

| Parameter    | Vital | Type   | Description                                                                 |
|--------------|-------|--------|-----------------------------------------------------------------------------|
| customerID   | Y     | String | Client code (provided by the IMILE platform)                                |
| format       | Y     | String | Data format, default : `json`                                               |
| accessToken  | Y     | String | Temporary token, except the interface for obtaining the token, all others require it |
| version      | Y     | String | Interface version number                                                    |
| signMethod   | Y     | String | Encryption, `SHA256` or `MD5`, Default: `SimpleKey`                         |
| timestamp    | Y     | String | Timestamp (the current number of milliseconds in the system)                |
| timeZone     | Y     | String | The caller's system time zone (e.g., `+8/GMT+8`, `+4/GMT+4`)              |
| param        | Y     | String | Request parameters, specific to each interface                              |

### Environments

*   **Testing Environment**: `https://openapi.52imile.cn`
*   **Production Environment**: `https://openapi.imile.com`

### Notes

*   If a required field is missing or exceeds its limitation, the `status` field in the response will be `error`.
*   Ignore unknown fields when deserializing the response to JSON.
*   The response HTTP status code is typically `200` for successful processing. In special scenarios (e.g., server overload), other codes like `500` may occur with an empty response body. Retry later in such cases.
```

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

### iMile API Introduction

Source: https://imiledeveloperskit.docs.apiary.io/reference/0/with-drawl-of-stocks

Overview of the iMile Developer's Kit, its capabilities, and how to get started with API integration.

```APIDOC
## iMile Developer's Kit Introduction

This API allows you to create dropship orders, reverse orders, and fulfillment orders, track your orders, and more. To get started, you will need to obtain your `CustomerID` and `APIKey` from the iMile team.

**Environments:**
*   **Testing:** `https://openapi.52imile.cn`
*   **Production:** `https://openapi.imile.com`
```

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

### Introduction to iMile APIs

Source: https://imiledeveloperskit.docs.apiary.io/introduction/e-commerce-plugins/create-api

An overview of the iMile Developer's Kit API, explaining its purpose and how to get started.

```APIDOC
## Introduction to iMile APIs

### Description
Welcome to the iMile Developer's Kit. This API enables you to integrate iMile's robust delivery services into your e-commerce platform. You can manage dropship orders, reverse orders, fulfillment orders, and track shipments with ease.

### Getting Started
To begin using the iMile APIs, please contact the iMile team to obtain your unique `CustomerID` and `APIKey`.
```

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

### iMile API Introduction

Source: https://imiledeveloperskit.docs.apiary.io/reference/0/print-awb-label/reprint-awb-label-1

Introduction to the iMile Developer's Kit and how to get started with their APIs. Obtain your CustomerID and APIKey to begin.

```APIDOC
## Introduction

Greetings, Thank you for choosing `iMile` as your `delivery partner`. You can use our APIs to create dropship orders, reverse orders and fulfillment orders, Track your order and more.

Please contact iMile team to get your `CustomerID` and `APIKey` to get started.

### Important API parameters.

Parameter | Vital | Type | Description
---|---|---|---
customerID | Y | String | Client code (provided by the IMILE platform)
format | Y | String | Data format, default : `json`
accessToken | Y | String | Temporary token, except the interface for obtaining the token, all other interfaces are required
version | Y | String | Interface version number
signMethod | Y | String | Encryption,`SHA256` or `MD5`, Default: `SimpleKey`
format | Y | String | Data format, default : `json`
timestamp | Y | String | Timestamp (the current number of milliseconds in the system, consistent with timeZone)
timeZone | Y | String | The caller's system time zone (+8/GMT+8), (+4/GMT+4)
param | Y | String | request parameters, different parameters for different interfaces
```

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

### iMile API Introduction

Source: https://imiledeveloperskit.docs.apiary.io/introduction/e-commerce-plugins/opencart

This section provides an overview of the iMile Developer's Kit, including how to get started and important notes regarding API usage and responses.

```APIDOC
## Introduction

Greetings, Thank you for choosing `iMile` as your `delivery partner`. You can use our APIs to create dropship orders, reverse orders and fulfillment orders, Track your order and more.

Please contact iMile team to get your `CustomerID` and `APIKey` to get started.

## Notes
* * *
  * If required field is missing in the request, or the length exceeds limitation, the status field in the response will be `error`
  * Please ignore unknown fields when deserialize response to JSON.
  * In this API, the response http status code is always `200` as long as the request is processed. The structure of the response is also fixed, always a JSON.
  * In some special scenario, API will response other http status code instead of `200`. For example when the server is too busy to process the request, it will response `500`. In such case, the response body will be empty. Please ignore the response body when http status code is not `200`, and suggest to retry later.
```

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

### Introduction to iMile APIs

Source: https://imiledeveloperskit.docs.apiary.io/reference/0/webhooks-live-tracking

Get started with the iMile APIs by obtaining your CustomerID and APIKey. The API supports creating various order types, tracking shipments, and managing fulfillment.

```APIDOC
## iMile Developer's Kit API

### Description
Welcome to the iMile Developer's Kit. This API allows you to integrate `iMile` delivery services into your applications. You can create dropship orders, reverse orders, fulfillment orders, and track your shipments.

To get started, please contact the iMile team to obtain your unique `CustomerID` and `APIKey`.

### Authentication
Most API requests require an `accessToken`. The process for obtaining this token is detailed in the 'Reference' section under 'Token'.

### Environments
*   **Testing Environment**: `https://openapi.52imile.cn`
*   **Production Environment**: `https://openapi.imile.com`

### Important API Parameters
These parameters are crucial for most API requests:

| Parameter    | Vital | Type   | Description                                                     |
|--------------|-------|--------|-----------------------------------------------------------------|
| customerID   | Y     | String | Client code provided by the IMILE platform.                     |
| format       | Y     | String | Data format, default: `json`.                                   |
| accessToken  | Y     | String | Temporary token required for most interfaces.                   |
| version      | Y     | String | Interface version number.                                       |
| signMethod   | Y     | String | Encryption method (`SHA256` or `MD5`), Default: `SimpleKey`.    |
| timestamp    | Y     | String | Current system time in milliseconds.                            |
| timeZone     | Y     | String | Caller's system time zone (e.g., `+8/GMT+8`, `+4/GMT+4`).       |
| param        | Y     | String | Request parameters, specific to each interface.                   |

### Notes on API Usage
*   If a required field is missing or exceeds its length limitation, the `status` field in the response will indicate an `error`.
*   Please ignore any unknown fields when deserializing the JSON response.
*   The API typically responds with an HTTP `200` status code for successful processing. The response will always be a JSON object.
*   In certain scenarios (e.g., server overload), the API might respond with a different HTTP status code (like `500`). In such cases, the response body will be empty. It is recommended to ignore the response body and retry the request later.
```

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

### Introduction to iMile APIs

Source: https://imiledeveloperskit.docs.apiary.io/reference/0/consignor-details/create-api

This section provides an overview of the iMile APIs, their purpose, and how to get started. It covers essential parameters required for API requests and general notes on API behavior and error handling.

```APIDOC
## Introduction to iMile APIs

This API allows you to integrate iMile delivery services into your applications. You can create dropship orders, reverse orders, and fulfillment orders, as well as track your orders.

### Getting Started
To get started, you will need a `CustomerID` and `APIKey` from the iMile team.

### Important API Parameters

| Parameter    | Vital | Type   | Description                                                                 |
|--------------|-------|--------|-----------------------------------------------------------------------------|
| customerID   | Y     | String | Client code (provided by the IMILE platform)                                |
| format       | Y     | String | Data format, default : `json`                                               |
| accessToken  | Y     | String | Temporary token, required for most interfaces                               |
| version      | Y     | String | Interface version number                                                    |
| signMethod   | Y     | String | Encryption method (`SHA256` or `MD5`), Default: `SimpleKey`                 |
| timestamp    | Y     | String | Timestamp (current milliseconds in the system)                              |
| timeZone     | Y     | String | The caller's system time zone (e.g., `+8/GMT+8`, `+4/GMT+4`)                |
| param        | Y     | String | Request parameters, specific to each interface                                |

### Notes on API Usage

*   If a required field is missing or exceeds limitations, the `status` field in the response will be `error`.
*   Ignore unknown fields when deserializing the response to JSON.
*   The response HTTP status code is typically `200` for processed requests. In special scenarios (e.g., server overload), a `500` status code might be returned with an empty response body. Retry later in such cases.

### Environments
*   **Testing Environment**: `https://openapi.52imile.cn`
*   **Production Environment**: `https://openapi.imile.com`
```

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

### Introduction to iMile APIs

Source: https://imiledeveloperskit.docs.apiary.io/reference/0/other-apis/otp-%280ne-time-password%29-at-the-time-of-delivery

This section provides an overview of the iMile API, its purpose, and how to get started. It also outlines important notes regarding request processing and response handling.

```APIDOC
## Introduction to iMile APIs

Greetings, Thank you for choosing `iMile` as your `delivery partner`. You can use our APIs to create dropship orders, reverse orders and fulfillment orders, Track your order and more.

Please contact iMile team to get your `CustomerID` and `APIKey` to get started.

### Notes

* If a required field is missing in the request, or the length exceeds the limitation, the status field in the response will be `error`.
* Please ignore unknown fields when deserializing the response to JSON.
* In this API, the response http status code is always `200` as long as the request is processed. The structure of the response is also fixed, always a JSON.
* In some special scenarios, the API will respond with a different http status code instead of `200`. For example, when the server is too busy to process the request, it will respond `500`. In such a case, the response body will be empty. Please ignore the response body when the http status code is not `200`, and suggest retrying later.
```

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

### Introduction to iMile APIs

Source: https://imiledeveloperskit.docs.apiary.io/introduction/e-commerce-plugins

This section provides an overview of the iMile APIs, their purpose, and how to get started. It explains how to use the APIs to create various types of orders, track shipments, and leverage fulfillment services.

```APIDOC
## Introduction to iMile APIs

### Description
Greetings, Thank you for choosing `iMile` as your `delivery partner`. You can use our APIs to create dropship orders, reverse orders and fulfillment orders, Track your order and more.

Please contact iMile team to get your `CustomerID` and `APIKey` to get started.

### Key Information
*   **Testing Environment**: `https://openapi.52imile.cn`
*   **Production Environment**: `https://openapi.imile.com`

### Important API Parameters

| Parameter    | Vital | Type   | Description                                                              |
|--------------|-------|--------|--------------------------------------------------------------------------|
| customerID   | Y     | String | Client code (provided by the IMILE platform)                             |
| format       | Y     | String | Data format, default : `json`                                            |
| accessToken  | Y     | String | Temporary token, required for most interfaces (except token acquisition) |
| version      | Y     | String | Interface version number                                                 |
| signMethod   | Y     | String | Encryption method (`SHA256` or `MD5`), Default: `SimpleKey`              |
| timestamp    | Y     | String | Timestamp (current milliseconds)                                         |
| timeZone     | Y     | String | The caller's system time zone (e.g., `+8/GMT+8`)                         |
| param        | Y     | String | Request parameters, specific to each interface                             |

### Notes on API Responses

*   If a required field is missing or exceeds its limitation, the `status` field in the response will be `error`.
*   Ignore unknown fields when deserializing responses to JSON.
*   The response HTTP status code is typically `200` for successful processing. The response body will always be a JSON.
*   In special scenarios (e.g., server overload), other HTTP status codes (like `500`) might be returned with an empty response body. In such cases, retry the request later.
```

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

### Introduction to iMile API

Source: https://imiledeveloperskit.docs.apiary.io/reference/0/other-apis/create-api

Welcome to the iMile Developer's Kit. This API allows you to manage orders, track shipments, and integrate with iMile's delivery services. You will need a CustomerID and APIKey to get started.

```APIDOC
## Introduction to iMile API

### Description
Welcome to the iMile Developer's Kit. This API allows you to create dropship orders, reverse orders, fulfillment orders, and track your orders. Please contact the iMile team to obtain your `CustomerID` and `APIKey` to begin integration.

### Key Information
*   **Testing Environment**: `https://openapi.52imile.cn`
*   **Production Environment**: `https://openapi.imile.com`

### Important API Parameters

| Parameter    | Vital | Type   | Description                                                                 |
|--------------|-------|--------|-----------------------------------------------------------------------------|
| customerID   | Y     | String | Client code provided by the IMILE platform.                                 |
| format       | Y     | String | Data format, default: `json`.                                               |
| accessToken  | Y     | String | Temporary token required for most interfaces (except token retrieval).      |
| version      | Y     | String | Interface version number.                                                   |
| signMethod   | Y     | String | Encryption method: `SHA256` or `MD5`. Default: `SimpleKey`.                 |
| timestamp    | Y     | String | Timestamp in milliseconds.                                                  |
| timeZone     | Y     | String | The caller's system time zone (e.g., `+8/GMT+8`, `+4/GMT+4`).                |
| param        | Y     | String | Request parameters, specific to each interface.                             |

### Notes on API Usage

*   If a required field is missing or exceeds its limitation, the `status` field in the response will be `error`.
*   Please ignore unknown fields when deserializing the response JSON.
*   The API typically responds with an HTTP status code `200` for successful processing, with a JSON body.
*   In special cases (e.g., server overload), other HTTP status codes (like `500`) may occur. In such scenarios, the response body might be empty. It is recommended to ignore the response body and retry later.
```

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

### iMile API - Introduction and Setup

Source: https://imiledeveloperskit.docs.apiary.io/reference/0/fulfillment-services

This section provides an overview of the iMile API, important parameters, and environment details.

```APIDOC
## iMile API Overview

### Description
This API allows you to integrate iMile's delivery services into your e-commerce platform. You can create orders, track shipments, manage returns, and more.

### Environments
*   **Testing Environment**: `https://openapi.52imile.cn`
*   **Production Environment**: `https://openapi.imile.com`

### Important API Parameters

| Parameter    | Vital | Type   | Description                                                                  |
|--------------|-------|--------|------------------------------------------------------------------------------|
| customerID   | Y     | String | Client code (provided by the IMILE platform)                                 |
| format       | Y     | String | Data format, default: `json`                                                 |
| accessToken  | Y     | String | Temporary token, required for most interfaces except token retrieval.        |
| version      | Y     | String | Interface version number                                                     |
| signMethod   | Y     | String | Encryption method (`SHA256` or `MD5`), Default: `SimpleKey`                  |
| timestamp    | Y     | String | Timestamp (current system milliseconds, consistent with timeZone)            |
| timeZone     | Y     | String | The caller's system time zone (e.g., `+8/GMT+8`, `+4/GMT+4`)                 |
| param        | Y     | String | Request parameters, varies by interface.                                     |

### Notes on Responses
*   If a required field is missing or exceeds limitations, the `status` field in the response will be `error`.
*   Ignore unknown fields when deserializing the response JSON.
*   The default HTTP status code for successful requests is `200`.
*   In special scenarios (e.g., server overload), a `500` status code might be returned with an empty response body. Retry later in such cases.
```

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

### API Introduction and Authentication

Source: https://imiledeveloperskit.docs.apiary.io/reference/0/print-awb-label/create-api

Introduction to the iMile Developer's Kit and important API parameters for authentication and request formatting. Includes base URLs for testing and production environments.

```APIDOC
## iMile Developer's Kit API

### Description
This API allows developers to integrate iMile's delivery services into their applications. Key functionalities include creating orders, tracking shipments, managing fulfillment, and handling returns.

### Base URLs
- **Testing Environment**: `https://openapi.52imile.cn`
- **Production Environment**: `https://openapi.imile.com`

### Important API Parameters

#### Authentication and Request Parameters

| Parameter      | Required | Type   | Description                                                                   |
|----------------|----------|--------|-------------------------------------------------------------------------------|
| `customerID`   | Yes      | String | Client code provided by the iMile platform.                                   |
| `format`       | Yes      | String | Data format, default: `json`.                                                 |
| `accessToken`  | Yes      | String | Temporary token required for all interfaces except token acquisition.         |
| `version`      | Yes      | String | Interface version number.                                                     |
| `signMethod`   | Yes      | String | Encryption method (`SHA256` or `MD5`), Default: `SimpleKey`.                  |
| `timestamp`    | Yes      | String | Timestamp in milliseconds (current system time).                              |
| `timeZone`     | Yes      | String | The caller's system time zone (e.g., `+8/GMT+8`, `+4/GMT+4`).                 |
| `param`        | Yes      | String | Request parameters, specific to each interface.                               |

### Notes on Responses

* If a required field is missing or exceeds limitations, the `status` field in the response will be `error`.
* Ignore unknown fields when deserializing responses.
* The HTTP status code is typically `200` for successful processing. In case of server overload (`500`), the response body will be empty; retry later.

```

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

### iMile API - Introduction and Authentication

Source: https://imiledeveloperskit.docs.apiary.io/reference/0/cancel-order/create-api

This section provides an overview of the iMile APIs and essential parameters required for authentication and making requests. It outlines the testing and production environment URLs.

```APIDOC
## iMile API - Introduction and Authentication

### Description

This API allows you to integrate with iMile's delivery services. To get started, you will need a `CustomerID` and `APIKey` from the iMile team. All API requests require specific parameters for authentication and proper processing.

### Base URLs

*   **Testing Environment**: `https://openapi.52imile.cn`
*   **Production Environment**: `https://openapi.imile.com`

### Important API Parameters

| Parameter    | Vital | Type   | Description                                                                   |
|--------------|-------|--------|-------------------------------------------------------------------------------|
| customerID   | Y     | String | Client code (provided by the IMILE platform)                                  |
| format       | Y     | String | Data format, default: `json`                                                  |
| accessToken  | Y     | String | Temporary token, required for most interfaces except token retrieval.         |
| version      | Y     | String | Interface version number                                                      |
| signMethod   | Y     | String | Encryption method (`SHA256` or `MD5`), Default: `SimpleKey`                   |
| timestamp    | Y     | String | Timestamp (current milliseconds in the system, consistent with timeZone)      |
| timeZone     | Y     | String | The caller's system time zone (e.g., `+8/GMT+8`, `+4/GMT+4`)                  |
| param        | Y     | String | Request parameters, specific to each interface                                  |

### Notes on Request Processing

*   If a required field is missing or exceeds its limitation, the `status` field in the response will be `error`.
*   Ignore unknown fields when deserializing the JSON response.
*   The default HTTP status code for successful requests is `200`.
*   In special scenarios (e.g., server overload), a `500` status code may be returned with an empty response body. Retry the request later in such cases.
```

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

### iMile API Overview

Source: https://imiledeveloperskit.docs.apiary.io/reference/0/fulfillment-services/create-asn

Overview of the iMile Developer's Kit API, including introduction, environment details, and important parameters.

```APIDOC
## iMile Developer's Kit API

### Introduction
Greetings, Thank you for choosing `iMile` as your `delivery partner`. You can use our APIs to create dropship orders, reverse orders and fulfillment orders, Track your order and more.
Please contact iMile team to get your `CustomerID` and `APIKey` to get started.

### Notes
* If required field is missing in the request, or the length exceeds limitation, the status field in the response will be `error`.
* Please ignore unknown fields when deserialize response to JSON.
* In this API, the response http status code is always `200` as long as the request is processed. The structure of the response is also fixed, always a JSON.
* In some special scenario, API will response other http status code instead of `200`. For example when the server is too busy to process the request, it will response `500`. In such case, the response body will be empty. Please ignore the response body when http status code is not `200`, and suggest to retry later.

### Environments
**Testing Environment** : `https://openapi.52imile.cn`
**Production Environment** : `https://openapi.imile.com`

### Important API Parameters
Parameter | Vital | Type | Description  
---|---|---|---
customerID | Y | String | Client code (provided by the IMILE platform)
format | Y | String | Data format, default : `json`
accessToken | Y | String | Temporary token, except the interface for obtaining the token, all other interfaces are required
version | Y | String | Interface version number
signMethod | Y | String | Encryption,`SHA256` or `MD5`, Default: `SimpleKey`
format | Y | String | Data format, default : `json`
timestamp | Y | String | Timestamp (the current number of milliseconds in the system, consistent with timeZone)
timeZone | Y | String | The caller's system time zone (+8/GMT+8), (+4/GMT+4)
param | Y | String | request parameters, different parameters for different interfaces
```

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

### iMile API Introduction

Source: https://imiledeveloperskit.docs.apiary.io/introduction/http-error-code

This section provides an overview of the iMile Developer's Kit API, its purpose, and how to get started. It also outlines important notes regarding request processing, response formats, and error handling.

```APIDOC
## Introduction to iMile Developer's Kit API

### Description
Welcome to the iMile Developer's Kit! This API enables you to integrate iMile's delivery services, including creating dropship orders, reverse orders, fulfillment orders, and tracking your shipments. To begin, you will need to obtain your `CustomerID` and `APIKey` from the iMile team.

### Important Notes
*   **Required Fields:** If a required field is missing or exceeds its specified length limitation, the `status` field in the response will indicate `error`.
*   **Unknown Fields:** Please ignore any fields in the response that are not explicitly documented.
*   **Response Status:** The API typically responds with an HTTP `200` status code for successful processing, with a JSON body. In exceptional cases, such as server overload, a `500` status code might be returned with an empty response body. In such scenarios, it is recommended to retry the request later.

### Environments
*   **Testing Environment:** `https://openapi.52imile.cn`
*   **Production Environment:** `https://openapi.imile.com`
```

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

### Introduction and Authentication

Source: https://imiledeveloperskit.docs.apiary.io/reference/0/tracking-orders/tracking-orders-with-codes

Provides an overview of the iMile API and details on essential parameters required for authentication and making requests.

```APIDOC
## Introduction
Greetings, Thank you for choosing `iMile` as your `delivery partner`. You can use our APIs to create dropship orders, reverse orders and fulfillment orders, Track your order and more.
Please contact iMile team to get your `CustomerID` and `APIKey` to get started.

## Important API Parameters

### Path Parameters
There are no path parameters documented.

### Query Parameters

| Parameter    | Vital | Type   | Description                                                                   |
|--------------|-------|--------|-------------------------------------------------------------------------------|
| customerID   | Y     | String | Client code (provided by the IMILE platform)                                  |
| format       | Y     | String | Data format, default : `json`                                                 |
| accessToken  | Y     | String | Temporary token, except the interface for obtaining the token, all others required |
| version      | Y     | String | Interface version number                                                      |
| signMethod   | Y     | String | Encryption, `SHA256` or `MD5`, Default: `SimpleKey`                           |
| timestamp    | Y     | String | Timestamp (the current number of milliseconds in the system)                  |
| timeZone     | Y     | String | The caller's system time zone (e.g., `+8/GMT+8`)                              |
| param        | Y     | String | Request parameters, different parameters for different interfaces               |

### Request Body
Request bodies are specific to each endpoint and are detailed individually.
```

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

### GET /stocks/check

Source: https://imiledeveloperskit.docs.apiary.io/reference/0/webhooks-live-tracking/create-api

This API is to check the stocks.

```APIDOC
## GET /stocks/check

### Description
Checks the stocks.

### Method
GET

### Endpoint
/stocks/check

### Parameters
#### Query Parameters
- **skuCode** (string) - Required - SKU code.
- **warehouseCode** (string) - Required - Warehouse code.

### Request Example
/stocks/check?skuCode=SKU123&warehouseCode=ShenZhenCenter

### Response
#### Success Response (200)
- **availableQuantity** (integer) - The available quantity of the SKU in the warehouse.

#### Response Example
{
  "availableQuantity": 100
}
```

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

### GET /orders/track

Source: https://imiledeveloperskit.docs.apiary.io/introduction/imile-supported-area-list

Tracks the status of an order.

```APIDOC
## GET /orders/track

### Description
Keeps track of your orders.

### Method
GET

### Endpoint
/orders/track

### Parameters
#### Query Parameters
- **orderCode** (string) - Required - The order code to track.

### Request Example
```json
{
  
}
```

### Response
#### Success Response (200)
- **orderStatus** (string) - The current order status.

#### Response Example
```json
{
  "orderStatus": "Delivered"
}
```
```

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

### GET /stocks/check

Source: https://imiledeveloperskit.docs.apiary.io/introduction/imile-supported-area-list

Checks the available stock.

```APIDOC
## GET /stocks/check

### Description
Checks the stocks.

### Method
GET

### Endpoint
/stocks/check

### Parameters
#### Query Parameters
- **skuCode** (string) - Required - SKU code to check.

### Request Example
```json
{
  
}
```

### Response
#### Success Response (200)
- **availableQuantity** (integer) - The available quantity of the SKU.

#### Response Example
```json
{
  "availableQuantity": 100
}
```
```

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

### GET /orders/track/codes

Source: https://imiledeveloperskit.docs.apiary.io/introduction/imile-supported-area-list

Tracks orders with codes (up to 200).

```APIDOC
## GET /orders/track/codes

### Description
Keeps track of your Bulk orders. (Max 200 orders)

### Method
GET

### Endpoint
/orders/track/codes

### Parameters
#### Query Parameters
- **orderCodes** (array of strings) - Required - Array of order codes to track.

### Request Example
```json
{
  
}
```

### Response
#### Success Response (200)
- **orderStatuses** (array) - Array of order statuses.

#### Response Example
```json
{
  "orderStatuses": [{"orderCode": "order1", "status": "Delivered"}, {"orderCode": "order2", "status": "In Transit"}]
}
```
```

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

### Introduction to iMile APIs

Source: https://imiledeveloperskit.docs.apiary.io/introduction/endpoints

This section provides an overview of the iMile API capabilities, including creating various types of orders and tracking shipments. It also outlines the essential parameters required for API requests.

```APIDOC
## Introduction

Greetings, Thank you for choosing `iMile` as your `delivery partner`. You can use our APIs to create dropship orders, reverse orders and fulfillment orders, Track your order and more.

Please contact iMile team to get your `CustomerID` and `APIKey` to get started.

# Notes
* * *
  * If required field is missing in the request, or the length exceeds limitation, the status field in the response will be `error`
  * Please ignore unknown fields when deserialize response to JSON.
  * In this API, the response http status code is always `200` as long as the request is processed. The structure of the response is also fixed, always a JSON.
  * In some special scenario, API will response other http status code instead of `200`. For example when the server is too busy to process the request, it will response `500`. In such case, the response body will be empty. Please ignore the response body when http status code is not `200`, and suggest to retry later.

# Endpoints
* * *
**Testing Environment** : `https://openapi.52imile.cn`
**Production Environment** : `https://openapi.imile.com`
* * *

# Important API parameters.
Parameter | Vital | Type | Description  
---|---|---|---  
customerID | Y | String | Client code (provided by the IMILE platform)  
format | Y | String | Data format, default : `json`  
accessToken | Y | String | Temporary token, except the interface for obtaining the token, all other interfaces are required  
version | Y | String | Interface version number  
signMethod | Y | String | Encryption,`SHA256` or `MD5`, Default: `SimpleKey`  
format | Y | String | Data format, default : `json`  
timestamp | Y | String | Timestamp (the current number of milliseconds in the system, consistent with timeZone)  
timeZone | Y | String | The caller's system time zone (+8/GMT+8), (+4/GMT+4)  
param | Y | String | request parameters, different parameters for different interfaces  
  * Always use the pickup servcies when creating an order for a timely collection, faster processing, and improved customer convenience.
```

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

### Cancel Order API Request Example

Source: https://imiledeveloperskit.docs.apiary.io/reference/0/cancel-order/cancel-order

This snippet demonstrates how to cancel an order using the iMile API. It includes the necessary request parameters such as customerId, sign, accessToken, signMethod, format, version, timestamp, timeZone, and the param object containing orderCode and waybillNo. The example uses JSON format.

```JSON
{
  "customerId": "C2102192601",
  "sign": "MIICdQIBADANBgkqhkiG9w0BAQEFAASCAl8wggJbAgEAAoGBAIuTQjg8rVUldwxB",
  "accessToken": "2ad5d704-c35a-4357-bc15-151072a0c7db",
  "signMethod": "SimpleKey",
  "format": "json",
  "version": "1.0.0",
  "timestamp": 1648883951481,
  "timeZone": "+4",
  "param": {
    "orderCode": "ML0978234091957",
    "waybillNo": "6062022280678"
  }
}
```

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

### iMile API Overview

Source: https://imiledeveloperskit.docs.apiary.io/reference/0/token

This section provides an overview of the iMile Developer's Kit API, including introduction, important parameters, and environment details.

```APIDOC
## iMile Developer's Kit API Overview

### Description
This API allows you to integrate iMile's delivery services into your e-commerce platform. You can create dropship orders, reverse orders, fulfillment orders, track shipments, and more.

### Introduction
Greetings, Thank you for choosing `iMile` as your `delivery partner`. You can use our APIs to create dropship orders, reverse orders and fulfillment orders, Track your order and more.
Please contact iMile team to get your `CustomerID` and `APIKey` to get started.

### Important API Parameters

| Parameter    | Vital | Type   | Description                                                                   |
|--------------|-------|--------|-------------------------------------------------------------------------------|
| customerID   | Y     | String | Client code (provided by the IMILE platform)                                  |
| format       | Y     | String | Data format, default : `json`                                                 |
| accessToken  | Y     | String | Temporary token, except the interface for obtaining the token, all other interfaces are required |
| version      | Y     | String | Interface version number                                                      |
| signMethod   | Y     | String | Encryption, `SHA256` or `MD5`, Default: `SimpleKey`                           |
| timestamp    | Y     | String | Timestamp (the current number of milliseconds in the system, consistent with timeZone) |
| timeZone     | Y     | String | The caller's system time zone (`+8/GMT+8`, `+4/GMT+4`)                        |
| param        | Y     | String | Request parameters, different parameters for different interfaces               |

### Environments
**Testing Environment** : `https://openapi.52imile.cn`
**Production Environment** : `https://openapi.imile.com`

### Notes
* If a required field is missing in the request, or the length exceeds the limitation, the status field in the response will be `error`.
* Please ignore unknown fields when deserializing responses to JSON.
* In this API, the response HTTP status code is always `200` as long as the request is processed. The structure of the response is also fixed, always a JSON.
* In some special scenarios, the API will respond with other HTTP status codes instead of `200`. For example, when the server is too busy to process the request, it will respond `500`. In such a case, the response body will be empty. Please ignore the response body when the HTTP status code is not `200`, and suggest retrying later.
```

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

### GET /track/order

Source: https://imiledeveloperskit.docs.apiary.io/reference/0/print-awb-label

API to track the status of a single order.

```APIDOC
## GET /track/order

### Description
This API keeps a track of your orders.

### Method
GET

### Endpoint
/track/order

### Parameters
#### Query Parameters
- **orderCode** (string) - Required - The order code to track.

### Request Example
```
GET /track/order?orderCode=6070623856210
```

### Response
#### Success Response (200)
- **data** (object) - Contains tracking information.
- **message** (string) - Success message.
- **code** (string) - Response code.
```

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

### GET /stocks

Source: https://imiledeveloperskit.docs.apiary.io/reference/0/print-awb-label

API to check the current stock levels.

```APIDOC
## GET /stocks

### Description
This API is to check the stocks.

### Method
GET

### Endpoint
/stocks

### Parameters
#### Query Parameters
- **skuCode** (string) - Required - The SKU code to check stock for.

### Request Example
```
GET /stocks?skuCode=SKU12345
```

### Response
#### Success Response (200)
- **data** (object) - Contains stock information.
- **message** (string) - Success message.
- **code** (string) - Response code.
```

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

### API Endpoints and Environments

Source: https://imiledeveloperskit.docs.apiary.io/introduction/imile-supported-country-list

Information on the available environments for testing and production, along with a link to a sample Postman collection for easy API exploration.

```APIDOC
# Endpoints
* * *
**Testing Environment** : `https://openapi.52imile.cn`
**Production Environment** : `https://openapi.imile.com`
* * *
# Postman Collection
**Sample Postman Collection:** https://api.postman.com/collections/11209317-8223f8a1-6293-414e-9fe4-d496041ec7ad?access_key=PMAT-01H4F0SR8G1QK1C4QJ4602653K
* * *
```

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

### Environment Details

Source: https://imiledeveloperskit.docs.apiary.io/reference/0/other-apis/otp-%280ne-time-password%29-at-the-time-of-delivery

Information about the iMile API testing and production environments.

```APIDOC
## Environment Details

**Testing Environment**: `https://openapi.52imile.cn`
**Production Environment**: `https://openapi.imile.com`
```

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

### GET /tracking/order

Source: https://imiledeveloperskit.docs.apiary.io/introduction/problem-status

API to track the status of a single order.

```APIDOC
## GET /tracking/order

### Description
This API keeps a track of your orders.

### Method
GET

### Endpoint
/tracking/order

### Parameters
#### Query Parameters
- **waybillNo** (string) - Required - The iMile waybill number of the order to track.

### Request Example
```json
{
  "waybillNo": "WAYBILL_NUM_FGHIJ"
}
```

### Response
#### Success Response (200)
- **trackingInfo** (object) - Contains detailed tracking information.
  - **waybillNo** (string) - The waybill number.
  - **status** (string) - The current status of the order.
  - **events** (array) - A list of tracking events.
    - **timestamp** (string) - The time of the event.
    - **location** (string) - The location of the event.
    - **description** (string) - A description of the event.

#### Response Example
```json
{
  "code": "200",
  "message": "Success",
  "data": {
    "trackingInfo": {
      "waybillNo": "WAYBILL_NUM_FGHIJ",
      "status": "Delivered",
      "events": [
        {
          "timestamp": "2023-10-26T10:00:00+08:00",
          "location": "Origin",
          "description": "Order picked up"
        },
        {
          "timestamp": "2023-10-26T14:30:00+08:00",
          "location": "Hub A",
          "description": "In transit"
        },
        {
          "timestamp": "2023-10-27T09:00:00+08:00",
          "location": "Destination",
          "description": "Delivered"
        }
      ]
    }
  }
}
```
```

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

### Introduction to iMile APIs

Source: https://imiledeveloperskit.docs.apiary.io/introduction/imile-supported-country-list

Welcome to the iMile Developer's Kit. Use our APIs to create dropship orders, reverse orders, fulfillment orders, and track your orders. Contact the iMile team for your CustomerID and APIKey to begin.

```APIDOC
## Introduction

Greetings, Thank you for choosing `iMile` as your `delivery partner`. You can use our APIs to create dropship orders, reverse orders and fulfillment orders, Track your order and more.

Please contact iMile team to get your `CustomerID` and `APIKey` to get started.
```

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

### GET /stocks

Source: https://imiledeveloperskit.docs.apiary.io/introduction/problem-status

API to check the current stock levels.

```APIDOC
## GET /stocks

### Description
This API is to check the stocks.

### Method
GET

### Endpoint
/stocks

### Parameters
#### Query Parameters
- **sku** (string) - Optional - Filter stocks by SKU.
- **warehouse_code** (string) - Optional - Filter stocks by warehouse.

### Request Example
```json
{
  "sku": "SKU123",
  "warehouse_code": "SHENZHEN"
}
```

### Response
#### Success Response (200)
- **stocks** (array) - List of stock information.
  - **sku** (string) - The SKU identifier.
  - **quantity** (integer) - The available quantity.
  - **warehouse** (string) - The warehouse where the stock is located.

#### Response Example
```json
{
  "code": "200",
  "message": "Success",
  "data": {
    "stocks": [
      {
        "sku": "SKU123",
        "quantity": 50,
        "warehouse": "SHENZHEN"
      }
    ]
  }
}
```
```

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

### iMile API Endpoints Overview

Source: https://imiledeveloperskit.docs.apiary.io/reference/0/webhooks-live-tracking/create-api

This section provides an overview of the available iMile API endpoints, including testing and production environments.

```APIDOC
## iMile API Endpoints

### Description
This documentation outlines the available endpoints for the iMile Developer's Kit, which supports various logistics operations.

### Testing Environment
`https://openapi.52imile.cn`

### Production Environment
`https://openapi.imile.com`
```

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

### GET /orders/track/bulk

Source: https://imiledeveloperskit.docs.apiary.io/introduction/imile-supported-area-list

Tracks multiple orders in bulk (up to 100).

```APIDOC
## GET /orders/track/bulk

### Description
Keeps track of your Bulk orders. (Max 100 orders)

### Method
GET

### Endpoint
/orders/track/bulk

### Parameters
#### Query Parameters
- **orderCodes** (array of strings) - Required - Array of order codes to track.

### Request Example
```json
{
  
}
```

### Response
#### Success Response (200)
- **orderStatuses** (array) - Array of order statuses.

#### Response Example
```json
{
  "orderStatuses": [{"orderCode": "order1", "status": "Delivered"}, {"orderCode": "order2", "status": "In Transit"}]
}
```
```
Tokens:
Raw