Order API Documentation
Create Shipping Order
Endpoint
POST https://www.shippinglabels.shop/v2/
Request Parameters
Headers
| Content-Type | application/json |
| KEY | Register and log in to get |
| SERVIE | USPS |
| CODE | USPS-93-GP |
JSON Body Structure
| Field | Type | Required | Description |
| orderid | string | Yes | Unique order identifier |
| weight | string | Yes | Unique order weight |
| from object: Sender information |
| from.name | string | Yes | Sender's full name |
| from.mobilePhone | string | Yes | Sender's contact number |
| from.detailAddress | string | Yes | Street address |
| from.street | string | Yes | Street name |
| from.state | string | Yes | State abbreviation |
| from.city | string | Yes | City name |
| from.zipCode | string | Yes | Postal code |
| from.countryCode | string | Yes | 2-letter country code |
| from.ischeck | int | No | 1 or 0 default 0 |
| to object: Recipient information |
| to.name | string | Yes | Recipient's full name |
| to.mobilePhone | string | Yes | Recipient's contact number |
| to.detailAddress | string | Yes | Street address |
| to.street | string | Yes | Street name |
| to.state | string | Yes | State abbreviation |
| to.city | string | Yes | City name |
| to.zipCode | string | Yes | Postal code |
| to.countryCode | string | Yes | 2-letter country code |
| package array: Package details |
| package[].length | string | Yes | Package length in cm |
| package[].width | string | Yes | Package width in cm |
| package[].height | string | Yes | Package height in cm |
| package[].weight | string | Yes | Package weight in kg |
Request Example
{
"orderid": "20250000test",
"weight": "1",
"remake1": "xxx",
"remake2": "xxx",
"from": {
"name": "Oliver",
"mobilePhone": "1234567890",
"detailAddress": "xx address",
"street": "xx street",
"state": "TX",
"city": "Houston",
"zipCode": "00000",
"countryCode": "US"
},
"to": {
"name": "Andy",
"mobilePhone": "1234567890",
"detailAddress": "xx address",
"street": "xx street",
"state": "TX",
"city": "Houston",
"zipCode": "00000",
"countryCode": "US"
},
"package": [{
"lenth": "10",
"width": "10",
"height": "10",
"weight": "10"
}]
}
Response
Success (200 Created)
{
"code": 200,
"data": "",
"file": "a.pdf",
"num": "93xxx",
"fee":10,
"msg": ""
}
Rate Limits
Order refund
Endpoint
POST https://www.shippinglabels.shop/v2/cancel
Request Parameters
Headers
| Content-Type | application/json |
| KEY | Register and log in to get |
JSON Body Structure
| Field | Type | Required | Description |
| orderid | array | Yes | Unique order identifier |
Request Example
{
"orderid": ["20250000test","20250000test"],
}
Response
Success (200 Created)
{
"code": 200,
"data": "",
"msg": "Application successful"
}
Rate Limits
Scanform
Endpoint
POST https://www.shippinglabels.shop/v2/scanform
Request Parameters
Headers
| Content-Type | application/json |
| KEY | Register and log in to get |
| SERVIE | USPS |
| CODE | USPS-93-GP |
JSON Body Structure
| Field | Type | Required | Description |
| track | array | Yes | |
| from object: Sender information |
| from.name | string | Yes | Sender's full name |
| from.mobilePhone | string | Yes | Sender's contact number |
| from.detailAddress | string | Yes | Street address |
| from.street | string | Yes | Street name |
| from.state | string | Yes | State abbreviation |
| from.city | string | Yes | City name |
| from.zipCode | string | Yes | Postal code |
| from.countryCode | string | Yes | 2-letter country code |
Request Example
{
"track": ["92001xxxx","92055xxxx"],
"from": {
"name": "Oliver",
"mobilePhone": "1234567890",
"detailAddress": "xx address",
"street": "xx street",
"state": "TX",
"city": "Houston",
"zipCode": "00000",
"countryCode": "US"
},
}
Response
Success (200 Created)
{
"code": 200,
"data": {"pdf":"http://aaa.pdf"},
"msg": "successful"
}
Rate Limits
Label
Endpoint
POST https://www.shippinglabels.shop/v2/label
Request Parameters
Headers
| Content-Type | application/json |
| KEY | Register and log in to get |
JSON Body Structure
| Field | Type | Required | Description |
| orderid | string | Yes | |
Request Example
{"orderid": "6zz211d7e021904520e519665"}
Response
Success (200 Created)
{
"code": 200,
"data": {"pdf":"http://aaa.pdf","num":"92xxx"},
"msg": "successful"
}
Rate Limits