Order Get

GET{{api_url}}/shop/order/{{orderid}}

Returns one complete order by its InfiPlex order ID: addresses, totals, status flags, line items with the warehouse each line was routed to, and every package shipped against it with tracking. Notes, additional info, coupons, and RMA numbers come back in the same response.

orderid is the InfiPlex order ID (shop_orderid), not the marketplace order number. To find an order from its marketplace order number, use Order Search with text_search.

Example

{{api_url}}/shop/order/101769

Response

A single JSON object. The full response carries more fields than shown here. This example is trimmed to the key fields documented below:

{
    "shop_orderid": "101769",
    "order_source": "Walmart",
    "external_order_num": "1000-048073-662360",
    "order_date": "2028-05-16 17:56:06",
    "date_created": "2028-06-09 13:43:04",
    "last_modified": "2028-06-10 14:29:37",
    "ship_first_name": "Scott",
    "ship_last_name": "Smith",
    "ship_street1": "1111 Infinite Lane",
    "ship_city": "Your City",
    "ship_state": "IL",
    "ship_zip": "60188",
    "ship_country": "US",
    "ship_price": "2.95",
    "item_total": "14.99",
    "discount_total": "0.00",
    "ship_total": "2.95",
    "tax_total": "0.00",
    "order_total": "17.94",
    "order_currency": "usd",
    "is_processed": "0",
    "fully_shipped": "1",
    "is_canceled": "0",
    "order_items": [
        {
            "shop_order_itemid": "1110",
            "sku": "08756-1",
            "product_name": "Twinings Earl Grey Tea 24 ct",
            "price": "14.99",
            "quantity": "1",
            "item_total": "14.99",
            "external_itemid": "155239",
            "quantity_shipped": "1",
            "quantity_to_ship": 0,
            "warehouse": [
                {"warehouse_name": "Secondary Warehouse", "warehouse_identifier": "secondary", "quantity": "1", "bin_location": null, "drop_shipper_id": "1"}
            ]
        }
    ],
    "tracking_numbers": [
        {
            "shop_order_ship_trackingid": "1086",
            "tracking_num": "1234567890",
            "carrier_name": "FedEx",
            "carrier_method": "NextDay",
            "date_created": "2028-06-10 14:29:37",
            "is_delivered": "0",
            "package_items": [
                {"sosti_itemid": "1110", "sku": "08756-1", "quantity_shipped": "1"}
            ]
        }
    ],
    "coupons": null,
    "rma_numbers": [],
    "notes": null,
    "additional_info": null
}

Order fields

Field	Description
`shop_orderid`	The InfiPlex order ID. This is the `orderid` every order endpoint takes.
`external_order_num`	The order number on the sales channel.
`order_source`	The sales channel the order came from.
`order_date`	The order date as received from the sales channel or other source the order came from.
`date_created`	When the order was saved in InfiPlex.
`last_modified`	When the order last changed. Order Search filters on this with `last_modified_start_date` and `last_modified_end_date`.
`po_number`	The purchase order number, if any.
`order_tag`	The order's tag, if any.
`email`, `phone`	The customer's email and phone.
`ship_first_name`, `ship_last_name`, `ship_company`, `ship_street1`, `ship_street2`, `ship_city`, `ship_state`, `ship_region`, `ship_zip`, `ship_country`	The ship-to address. `ship_country` is a two-letter code.
`bill_first_name`, `bill_last_name`, `bill_company`, `bill_street1`, `bill_street2`, `bill_city`, `bill_state`, `bill_region`, `bill_zip`, `bill_country`	The billing address.
`ship_label`	The ship method on the order, for example `UPS Ground`.
`ship_price`	Shipping charged to the customer.
`item_total`, `discount_total`, `ship_total`, `tax_total`, `order_total`	The order's totals. `order_total` is `item_total` plus `ship_total` plus `tax_total`, minus `discount_total`.
`order_currency`	The currency code, lowercase, for example `usd`.
`is_processed`	`1` when the order has been flagged processed. Set it with Processed.
`fully_shipped`	`1` when every line has shipped.
`is_canceled`	`1` when the order is canceled.
`is_seller_fulfilled_prime`	`1` for Amazon Seller Fulfilled Prime orders.
`estimated_ship_date`, `estimated_delivery_date`	The order's estimated ship and delivery dates, when set.

Line item fields (order_items)

Field	Description
`shop_order_itemid`	The order line ID. Order Tracking Create takes this as `itemid` in `package_items`.
`sku`	The line's SKU.
`product_name`	The product name on the line.
`quantity`	Units ordered.
`price`	Unit price.
`item_total`, `tax_total`, `discount_total`, `ship_total`	The line's totals.
`external_itemid`	The line item ID on the sales channel.
`item_upc`, `item_isbn`, `item_asin`, `item_gtin`, `item_ean`	Product identifiers on the line.
`is_amazon_fba`	`1` when Amazon fulfills the line.
`quantity_shipped`, `quantity_to_ship`	Units shipped so far, and units still to ship.
`quantity_returned`, `quantity_to_return`	Units returned so far, and units still available to return.
`warehouse`	Where the line was routed. There is one entry per warehouse filling the line, each with `warehouse_name`, `warehouse_identifier`, `quantity`, `bin_location`, and `drop_shipper_id`.

Package fields (tracking_numbers)

Field	Description
`shop_order_ship_trackingid`	The package ID.
`tracking_num`	The tracking number.
`carrier_name`, `carrier_method`	The carrier and service level, for example `FedEx` and `NextDay`.
`date_created`	When the package was recorded.
`length_inches`, `width_inches`, `height_inches`	Package dimensions.
`is_delivered`, `estimated_delivery`	`1` once the package is delivered, and its estimated delivery.
`package_items`	The lines in this package. Each entry has `sosti_itemid` (the order line's `shop_order_itemid`), `sku`, and `quantity_shipped`.

Other sections

Field	Description
`notes`	Internal notes on the order. Add one with Order Note Create.
`additional_info`	Additional info fields on the order. Add one with Order Additional Info Create.
`coupons`	Coupons applied to the order.
`rma_numbers`	RMA numbers on the order.

Before you build

Most values come back as strings, including numbers and 1/0 flags. A few, such as is_amazon_fba and quantity_to_ship, come back as numbers. Convert before comparing.
Sections with nothing in them come back as null or as an empty array, for example notes: null and rma_numbers: []. Check for both before looping.
A line split across warehouses has more than one entry in warehouse. A line shipped in more than one package appears in each package's package_items.
To see why a line was routed to its warehouse, use Order Get Warehouse Routing Explanation.
Timestamps are in your account's time zone, formatted 2028-06-10 14:29:37. A timestamp in UTC says so in its field name, for example date_time_utc.
Your API key needs Order read permission. A key without it gets 403 Forbidden.

Related guides:

Authorization

Bearer token, sent in the Authorization header. Inherited from the collection.

Example Request

curl --location --request GET '{{api_url}}/shop/order/{{orderid}}' \
--header 'Authorization: Bearer {{auth_token}}'

Example Responses

Order Get

Request

curl --location --request GET 'https://example.com/api/admin/shop/order/101769' \
--header 'Authorization: Bearer YOUR_API_KEY'

Response 200 OK

{
    "shop_orderid": "101769",
    "shop_order_siteareaid": "16",
    "shop_order_uid": "0",
    "order_key": "NWLd0q4Mahtl3SFNv3XRu1Byfxw68gKAiRQuooSMtf2FZNYwdKIv4xJ0WEHShgi42GUWjfqXPCy5DD7LFV218gmTSNPRKD2sWUArQL55s2kZYeufdQ6jp6b4X9PnCODwEuxKZZ8vqmcfcTsQPfCwii9CaipaPhGgcbDKIlLsmI",
    "order_source": "Walmart",
    "order_date": "2018-05-16 17:56:06",
    "email": "",
    "phone": "",
    "ship_first_name": "Scott",
    "ship_last_name": "Smith",
    "ship_company": "",
    "ship_street1": "1111 Infinite Lane",
    "ship_street2": "",
    "ship_city": "Your City",
    "ship_state": "IL",
    "ship_region": "",
    "ship_zip": "60188",
    "ship_country": "US",
    "bill_first_name": "Scott",
    "bill_last_name": "Smith",
    "bill_company": "",
    "bill_street1": "777 Billing Street Ave.",
    "bill_street2": "",
    "bill_city": "Naperville",
    "bill_state": "IL",
    "bill_region": "",
    "bill_zip": "60188",
    "bill_country": "US",
    "ship_price": "2.95",
    "ship_handling": "0.00",
    "ship_identifier": "",
    "ship_type": "0",
    "ship_label": "",
    "ship_weight_total": "0.00",
    "ship_speed": "1",
    "item_total": "14.99",
    "discount_total": "0.00",
    "ship_total": "2.95",
    "tax_total": "0.00",
    "order_total": "17.94",
    "cc_type": "",
    "cc_num": null,
    "cc_exp_mon": "",
    "cc_exp_year": "",
    "cc_last_four": "",
    "is_processed": "0",
    "external_order_num": "1000-048073-662360",
    "external_order_source": null,
    "fully_shipped": "1",
    "is_amazon_payment": "0",
    "is_paypal_payment": "0",
    "is_canceled": "0",
    "quickbooks_user_listid": null,
    "is_saved_in_quickbooks": "0",
    "is_queued_for_quickbooks_save": "0",
    "quickbooks_invoice_listid": null,
    "order_tag": null,
    "in_process": "0",
    "processed_by": null,
    "processed_date": null,
    "order_tak": null,
    "order_referer": "",
    "date_created": "2018-06-09 13:43:04",
    "amazon_payment_order_id": null,
    "po_number": null,
    "session_id": null,
    "user_unq_identifier": null,
    "merchant_trans_id": null,
    "merchant_customer_profile_id": null,
    "merchant_customer_payment_profile_id": null,
    "has_outstanding_pre_order_items": "0",
    "pre_order_completed_date": null,
    "pre_order_release_date": null,
    "order_currency": "usd",
    "order_currency_symbol": "$",
    "last_modified": "2018-06-10 14:29:37",
    "is_seller_fulfilled_prime": "0",
    "gift_card_total": "0.00",
    "qbo_order_needs_pulling": "1",
    "qbo_sales_receipt_id": null,
    "order_fully_saved": "1",
    "outstanding_amazon_custom_prod": "0",
    "needs_to_run_drop_shipper_processing": "1",
    "is_walmart_dsv_ship_to_store": "0",
    "additional_customer_order_id": null,
    "payment_type": null,
    "payment_note": null,
    "merchant_name": null,
    "is_channel_advisor_order": "0",
    "channel_advisor_profile_id": null,
    "external_external_order_num": null,
    "external_external_order_source": null,
    "estimated_ship_date": null,
    "estimated_delivery_date": null,
    "order_items": [
        {
            "shop_order_itemid": "1110",
            "shop_order_item_orderid": "101769",
            "shop_order_item_productid": "116",
            "shop_order_item_skuid": null,
            "shop_order_item_clientid": null,
            "product_name": "Twinings Earl Grey Tea 24 ct",
            "product_description": "",
            "sku": "08756-1",
            "sku_description": "",
            "out_of_stock_message": null,
            "price": "14.99",
            "quantity": "1",
            "ship_weight": "0.00",
            "ship_weight_total": "0.00",
            "ship_total": "2.95",
            "tax_total": "0.00",
            "discount_total": "0.00",
            "item_total": "14.99",
            "tax_name": "",
            "tax_rate": "0.000",
            "external_itemid": "155239",
            "quickbooks_listid": null,
            "is_queued_for_quickbooks_save": "0",
            "ship_length_inches": "0.00",
            "ship_width_inches": "0.00",
            "ship_height_inches": "0.00",
            "item_cost": null,
            "pre_order_amount_remaining": "0.00",
            "pre_order_completed_date": null,
            "pre_order_release_date": null,
            "amazon_custom_prod": "0",
            "amazon_custom_prod_processed": "0",
            "is_amazon_fba": 0,
            "item_note": null,
            "item_upc": null,
            "item_isbn": null,
            "item_asin": null,
            "item_gtin": null,
            "item_ean": null,
            "item_additional_id": null,
            "option_info": null,
            "input_option_info": null,
            "warehouse": [
                {
                    "shop_order_item_warehouse": "698",
                    "soiw_itemid": "1110",
                    "warehouse_name": "Secondary Warehouse",
                    "warehouse_identifier": "secondary",
                    "quantity": "1",
                    "bin_location": null,
                    "drop_shipper_id": "1"
                }
            ],
            "quantity_shipped": "1",
            "quantity_to_ship": 0,
            "quantity_returned": 0,
            "quantity_to_return": "1",
            "customization_info": null,
            "friendly_url": "",
            "images": null
        }
    ],
    "tracking_numbers": [
        {
            "shop_order_ship_trackingid": "1086",
            "sost_orderid": "101769",
            "tracking_num": "1234567890",
            "date_created": "2018-06-10 14:29:37",
            "email_sent": null,
            "email_sent_date": null,
            "balancemaxx_tracking_sent": "0",
            "balancemaxx_tracking_sent_date": null,
            "label_cost": null,
            "label_img": null,
            "overload_ship_weight_total": null,
            "length_inches": "0",
            "width_inches": "0",
            "height_inches": "0",
            "carrier_name": "FedEx",
            "carrier_method": "NextDay",
            "is_amazon_fba": "0",
            "is_residential": "0",
            "use_negotiated": "0",
            "worldship_downloaded": "0",
            "standard_downloaded": "0",
            "signature_type": null,
            "is_delivered": "0",
            "estimated_delivery": null,
            "delivery_time": null,
            "tracking_activity_summary": null,
            "is_ups": "0",
            "is_fedex": "0",
            "is_stamps": "0",
            "should_still_check_tracking": "1",
            "last_tracking_activity_check": "2018-06-10 14:29:37",
            "carrier_will_pick_up": "0",
            "declared_value": null,
            "external_shipment_id": null,
            "is_walmart_dsv_ship_to_store": "0",
            "walmart_asn": null,
            "usps_zone": null,
            "package_size_name": null,
            "packing_slip_id": null,
            "order_source": "Groupon",
            "external_order_num": "1000-048073-662360",
            "shop_order_siteareaid": "16",
            "package_items": [
                {
                    "shop_order_ship_tracking_itemid": "1168",
                    "sosti_trackingid": "1086",
                    "sosti_itemid": "1110",
                    "quantity_shipped": "1",
                    "product_name": "Twinings Earl Grey Tea 24 ct",
                    "ship_weight": "0.00",
                    "external_itemid": "155239",
                    "sku": "08756-1",
                    "ship_length_inches": "0.00",
                    "ship_width_inches": "0.00",
                    "ship_height_inches": "0.00",
                    "quantity": "1",
                    "item_upc": null,
                    "item_isbn": null,
                    "item_asin": null,
                    "item_gtin": null,
                    "item_ean": null,
                    "item_additional_id": null,
                    "sku_custom_data": null
                }
            ],
            "tracking_activity": null
        }
    ],
    "coupons": null,
    "rma_numbers": [],
    "notes": null,
    "email_drop_shipper_pos": null,
    "tasks": null,
    "additional_info": null
}

Order Get

Authorization

Example Request

Example Responses

Order Get

Request

Response 200 OK

Latest Posts

Useful Links

Contact Us