ParcelPanel API

**API**

**Get Tracking Details**

POST : api.parcelpanel.com/api/v1/order/post

Headers

| Key  | Value  | Description  |
| ------------ | ------------ | ------------ |
| Content-Type  | application/json  |   |
|  Parcelpanel-Api-Key | {{api_key}}  |   | |

Body

| Name  | Type  | Description  |
| ------------ | ------------ | ------------ |
| order_name (required)  | String  | Order name  |

<pre>
{
 "order_name": "#1479"
}
</pre>

<details style="padding:0 0 20px;"><summary>Response</summary>
<pre>
{
 "meta": {
 "code": 200,
 "type": "Success",
 "measage": "The request was successful."
 },
 "data": {
 "order_id":"2600441643094",
 "order_name":"#1001",
 "store_name":"test.myshopify.com",
 "customer_name":"Tom Alix",
 "email":"test@parcelpanel.org",
 "phone":"888-888-8888",
 "created_at":"2020-08-25 11:36:23",
 "total_price":"24.96",
 "subtotal_price":"24.96",
 "tax":"0.00",
 "currency":"CNY",
 "fulfillments":[
 {
 "shop_url":"https://test.myshopify.com",
 "order_id":"2600441643094",
 "order_name":"#1001",
 "track_number":"123456789",
 "shopify_carrier":"DHL Express",
 "carrier":{
 "slug":"dhl",
 "name":"DHL Express",
 "website":"http://www.dhl.com/",
 "phone":"800-810-8000",
 "track_url":"http://www.dhl.com/en/express/tracking.html?brand=DHL&amp;AWB=123456789"
 },
 "shipment_status":"delivered",
 "created_at":"2020-08-25 11:36:31",
 "last_event":"Delivered - Signed for by: LCP009 Plt dhl",
 "origin_country":"Thailand",
 "origin_weblink":"http://www.dhl.co.th/en/contact_center/contact_express.html#local_contact",
 "origin_phone":"800-810-8000",
 "destination_country":"New Zealand",
 "destination_weblink":"http://www.dhl.com/",
 "destination_phone":"800-810-8000",
 "line_items":[
 {
 "name":"(10 colors) 2019 autumn and winter new men's woolen coat 5XL large size slim long trench coat, fashion slim wild men's jacket - Khaki / M",
 "quantity":"1",
 "img":"https://cdn.shopify.com/s/files/1/1297/6081/products/product-image-974429930.jpg?v=1571353016",
 "product_id":"4001561247830",
 "variant_id":"29718845685846"
 }
 ],
 "trackinfo":[
 {
 "Date":"2020-06-19 09:58:00",
 "StatusDescription":"Delivered - Signed for by: LCP009 Plt dhl",
 "Details":"BLENHEIM",
 "checkpoint_status":"delivered"
 },
 {
 "Date":"2020-06-19 07:33:00",
 "StatusDescription":"with a courier for delivery",
 "Details":"NZ REGIONAL SERVICE AREA - NEW ZEALAND",
 "checkpoint_status":"out for delivery"
 },
 {
 "Date":"2020-06-17 11:30:00",
 "StatusDescription":"Arrived at Sort Facility AUCKLAND - NEW ZEALAND",
 "Details":"AUCKLAND - NEW ZEALAND",
 "checkpoint_status":"transit"
 },
 {
 "Date":"2020-06-16 04:33:00",
 "StatusDescription":"Arrived at Sort Facility SINGAPORE - SINGAPORE",
 "Details":"SINGAPORE - SINGAPORE",
 "checkpoint_status":"transit"
 },
 {
 "Date":"2020-06-15 17:09:00",
 "StatusDescription":"Processed at BANGKOK - THAILAND",
 "Details":"BANGKOK - THAILAND",
 "checkpoint_status":"transit"
 },
 {
 "Date":"2020-06-15 16:58:00",
 "StatusDescription":"Shipment picked up",
 "Details":"BANGKOK - THAILAND",
 "checkpoint_status":"transit",
 "ItemNode":"ItemReceived"
 }
 ]
 }
 ],
 "shipping_address":{
 "address1":"6399 Cable Avenue",
 "phone":"3212989961",
 "city":"Cocoa",
 "province":"Anhui",
 "country":"China",
 "address2":null,
 "company":null,
 "latitude":"28.4707401",
 "longitude":"-80.8050111",
 "name":"Tom Alix",
 "country_code":"CN",
 "province_code":"AH"
 }
 }
}
</pre>
</details>

| Code | Type | Message |
| ------------ | ------------ | ------------ |
| 200 | Success | The request was successful. |
| 201 | Not Found | Resource was empty. |
| 4001 | Bad Request | Api-Key is empty |
| 4002 | Bad Request | Order_name is required. |
| 4003 | Unauthorized | Invalid API key. |
| 429 | Too Many Requests | Wait one second and try again. |

<details style="padding:0 0 20px;"><summary>Rate Limit</summary>
If the rate limit is hit, the API will return a 429 status code (Too Many Requests), your application should not send any further requests and wait 60 sec.

POST v1/order/post –––– ≤50 requets per sec
</details>

**Update Shopify Shipment Status**

POST : api.parcelpanel.com/api/v1/order/status/update

Headers

| Key  | Value  | Description  |
| ------------ | ------------ | ------------ |
| Content-Type  | application/json  |   |
|  Parcelpanel-Api-Key | {{api_key}}  |   | |

Body

| Name | Type | Description |
| ------------ | ------------ | ------------ |
| track_number or order_name (required) | String | Tracking number or order name |
| status | String | Can be changed to: in_transit, out_for_delivery, delivered |
<pre>
{
 "track_number" : "2132143451233"
} 
or
{
 "order_name" : "#1612"
}
</pre>

| Code | Type | Message |
| ------------ | ------------ | ------------ |
| 200 | Success | The request was successful. |
| 201 | Not Found | Resource was empty. |
| 4001 | Bad Request | Api-Key is empty |
| 4002 | Bad Request | Track number or order name is required or Order does not exist or Status does not exist. |
| 4003 | Unauthorized | Invalid API key or Invalid shop. |
| 429 | Too Many Requests | Wait one second and try again. |

<details style="padding:0 0 20px;"><summary>Rate Limit</summary>
If the rate limit is hit, the API will return a 429 status code (Too Many Requests), your application should not send any further requests and wait 60 sec.

POST v1/order/status/update –––– ≤40 requets per min
</details>

ParcelPanel for WooCommerce has been released!!

ParcelPanel API