Resource Information


Description Endpoint to retrieve an order specified by it's Shopify id, found within the name field.
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 retrieve. False NULL

Example


GET https://api.mpstoolbox.com/v1/orders/1566

Response

{
    "id": 1698871279652,
    "name": "#1566",
    "purchase_order": "WN&PS",
    "order_status": "fulfilled",
    "payment_status": "pending",
    "order_created": "2019-09-25 16:44:23",
    "order_last_update": "2019-09-25 16:44:40",
    "order_weight": 0,
    "discount": 0,
    "items_total": 519.4,
    "tax": 62.33,
    "subtotal": 0,
    "total": 581.73,
    "customer": {
        "id": 1698871279652,
        "account_number": "",
        "company": "Niakwa Country Club",
        "first_name": "Rhianna",
        "last_name": "McLeod",
        "email": "nccadmin@niakwacountryclub.ca",
        "phone": "",
        "note": ""
    },
    "shipping_address": {
        "address": "620 Niakwa Rd.",
        "address1": "",
        "city": "Winnipeg",
        "state_province": "Manitoba",
        "post_code": "R2J2X3",
        "country_code": "CA"
    },
    "shipping_lines": [
        {
        "id": 1381878497316,
        "title": "Not Yet Set",
        "price": "0.00",
        "code": "custom",
        "source": "shopify",
        "phone": null,
        "requested_fulfillment_service_id": null,
        "delivery_category": null,
        "carrier_identifier": null,
        "discounted_price": "0.00",
        "price_set": {
            "shop_money": {
            "amount": "0.00",
            "currency_code": "CAD"
            },
            "presentment_money": {
            "amount": "0.00",
            "currency_code": "CAD"
            }
        },
        "discounted_price_set": {
            "shop_money": {
            "amount": "0.00",
            "currency_code": "CAD"
            },
            "presentment_money": {
            "amount": "0.00",
            "currency_code": "CAD"
            }
        },
        "discount_allocations": [],
        "tax_lines": [
            {
            "title": "PST",
            "price": "0.00",
            "rate": 0.07,
            "price_set": {
                "shop_money": {
                "amount": "0.00",
                "currency_code": "CAD"
                },
                "presentment_money": {
                "amount": "0.00",
                "currency_code": "CAD"
                }
            }
            },
            {
            "title": "GST",
            "price": "0.00",
            "rate": 0.05,
            "price_set": {
                "shop_money": {
                "amount": "0.00",
                "currency_code": "CAD"
                },
                "presentment_money": {
                "amount": "0.00",
                "currency_code": "CAD"
                }
            }
            }
        ]
        }
    ],
    "fulfillments": [
        {
        "id": 1605424152612,
        "status": "success",
        "fulfillment_created": "2019-09-25 16:44:40",
        "fulfillment_updated": "2019-09-25 16:44:40",
        "tracking_company": "",
        "shipment_status": "",
        "tracking_numbers": [],
        "tracking_urls": [],
        "receipt": null
        }
    ],
    "line_items": [
        {
        "id": 3773219340324,
        "sku": "106R02777-D",
        "name": "Xerox Black High Capacity Toner Cartridge - Purchase",
        "vendor": "Xerox",
        "supplier": "",
        "grams": 720,
        "discount": 0,
        "cost": 0,
        "price": 129.85,
        "quantity": 4,
        "serialnumber": "",
        "deviceid": 0,
        "assetid": "",
        "location": "",
        "ip": "",
        "tax_lines": null,
        "fulfillment_status": "",
        "fulfillment_service": ""
        }
    ],
    "sub_total": 519.4
}

Error Response

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