Resource Information


Description Endpoint to update tracking information for an order specified by it's Shopify id.
Resource URL https://api.mpstoolbox.com/v1/orders/{orderid}
Rate Limited False
Response Format JSON
Authentication API-Key

Parameters


Parameter Type Description Optional Default
orderid bigint The Shopify id of the order to add tracking details to. False NULL
details JSON Provide a JSON object containing the tracking information you want to update. The following fields are required:

notifycustomer
trackingURL
trackingnumber
trackingcompany
False NULL

Example


POST https://api.mpstoolbox.com/v1/orders/1007

Request

{
    "details": {
        "notifycustomer": true,
        "trackingURL": "https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=1Z001985YW99744790",
        "trackingnumber": "1Z001985YW99744790",
        "trackingcompany": "UPS"
    }
}

Response

{
    "code" : "200",
    "data" : true
}

Error Response

{
    "code": 204,
    "data": "No Data Found"
}