Get Order Status

Get the order status by specified the order number of existing order.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/ordermgmt/orderstatus/orders/{ordernumber}?sellerid={sellerid}&version={version}
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/ordermgmt/orderstatus/orders/{ordernumber}?sellerid={sellerid}&version={version}
Newegg.ca: https://api.newegg.com/marketplace/can/ordermgmt/orderstatus/orders/{ordernumber}?sellerid={sellerid}&version={version}

Note: Please make sure your request URL is all in lower case (except for Seller ID) and cannot contain any blank spaces or line breaks.

Parameters

Name Required? Description
sellerid Yes Your seller ID on Newegg Marketplace
ordernumber Yes The order number
version No Available version number: 304

Resource Information

HTTP Method Authentication? Request Formats Response Formats Rate Limited?
Get Required XML, Json XML, Json 500 request per hour

Request Body

Example: XML, Request

GET https://api.newegg.com/marketplace/ordermgmt/orderstatus/orders/{ordernumber}?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml

Example: Json, Request

GET https://api.newegg.com/marketplace/ordermgmt/orderstatus/orders/{ordernumber}?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json

Response Body

Attribute Format Description
OrderNumber String The order number that qualified for your search
OrderStatusCode Integer The available values of the order status:

  • 0: Unshipped
  • 1: PartiallyShipped
  • 2: Shipped
  • 3: Invoiced
  • 4: Void
OrderStatusName String The description of the status:

  • Unshipped for status code: 0
  • PartiallyShipped for status code: 1
  • Shipped for status code: 2
  • Invoiced for status code: 3
  • Void for status code: 4
SellerID String Your seller ID
OrderDownloaded String
  • False: Order has not been downloaded yet.
  • True: Order downloaded already.

When order is shipped, this field will automatically become “True”.
SalesChannel Integer Order sales channel:

  • 0: Newegg order
  • 1: Multi-channel order
  • 2: Replacement order
  • 3: NWS order (Newegg.com only)

Only available version: 304
FulfillmentOption Integer Order fulfillment option:

  • 0: Ship by Seller
  • 1: Ship by Newegg

Only available version: 304

Schema: GetOrderStatusResponse.xsd

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<QueryOrderStatusInfo>
    <OrderNumber>159243598</OrderNumber>
    <SellerID>A006</SellerID>
    <OrderStatusCode>1</OrderStatusCode>
    <OrderStatusName>PartiallyShipped</OrderStatusName>
    <OrderDownloaded>true</OrderDownloaded>
    <SalesChannel>0</SalesChannel>
    <FulfillmentOption>0</FulfillmentOption>
</QueryOrderStatusInfo>

Example: Json, Response

{
    "OrderDownloaded": true,
    "OrderNumber": "159243598",
    "OrderStatusCode": 1,
    "OrderStatusName": "PartiallyShipped",
    "SellerID": "A006",
    "SalesChannel": 0,
    "FulfillmentOption": 0
}

Request Failure Errors

For common HTTP error responses, please refer to Failed Response Error Code List.

Error Code Description
SO002 Order Number should be an integer (ranging from 1 to 2147483647)
SO003 No data found or this order does not belong to this seller

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<Errors>
    <Error>
        <Code>SO002</Code>
        <Message>Order Number should be an integer (ranging from 1 to 2147483647)</Message>
    </Error>
</Errors>

Example: Json, Response

[
    {
        "Code": "SO002",
        "Message": "Order Number should be an integer (ranging from 1 to 2147483647)"
    }
]

Last updated: October 28, 2021