Resource Information


Description Endpoint to retrieve a draft order by it's Shopify id.
Resource URL https://api.mpstoolbox.com/v1/draft_orders/{orderid}
Rate Limited False
Response Format JSON
Authentication API-Key

Parameters


Parameter Type Description Optional Default
orderid bigint The Shopify id of the draft order to retrieve. False NULL

Example


GET https://api.mpstoolbox.com/v1/draft_orders/D731

Response

{
    "general": {
        "order_id": 1058391359638,
        "order_type": "draft_order",
        "order_status": "open",
        "order_name": "#D731"
    },
    "customer": {
        "id": 6887495532694,
        "company": null,
        "first_name": "Noah",
        "last_name": "Miller",
        "email": "nmiller@mpstoolbox.com",
        "verified_email": true,
        "phone": null,
        "tags": "Purchase Order",
        "currency": "CAD"
    },
    "shipping_address": {
        "first_name": "Noah",
        "last_name": "Miller",
        "address1": "123 Fake Street",
        "address2": "",
        "company": "",
        "city": "toronto",
        "state_province": "ON",
        "zip_postal": "K7M 9G8",
        "country": "Canada",
        "phone": ""
    },
    "billing_address": {
        "first_name": "Noah",
        "last_name": "Miller",
        "address1": "123 Fake Street",
        "address2": "",
        "company": "",
        "city": "toronto",
        "state_province": "ON",
        "zip_postal": "K7M 9G8",
        "country": "Canada",
        "phone": ""
    },
    "line_items": [
        {
            "id": 57849986285718,
            "variant_id": 41535279923350,
            "quantity": 1,
            "product_name": "Kyocera ECOSYS M6635cidn",
            "sku": "1102V12US1",
            "weight": null,
            "weight_unit": null
        }
    ]
}

Error Response

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