GET Orders/GetUnfulfilled?start={start}&limit={limit}&since={since}

Gets unfulfilled orders

Request Information

URI Parameters

NameDescriptionTypeAdditional information
start

Optional: An offset into the list of returned items. Use 0 to start at the beginning. The API will return the requested number of items starting at this offset. Default to 0 if not supplied

integer

Default value is 0

limit

Optional: A limit on the number of products that can be returned. Limit can range from 1 to 500 items and the default is 50

integer

Default value is 50

since

Optional: all the orders that have been updated since the time value passed into this parameter (UTC)

date

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Order
NameDescriptionTypeAdditional information
OrderId

Unique identifier for the order

string

None.

LastUpdated

Date and time of the last update to the order

date

None.

ExpectedShipDate

(UTC) Date and time the order must be fulfilled by

date

None.

Quantity

Number of units that the user has purchased

string

None.

Color

The color of the item that was ordered (if applicable)

string

None.

Price

The price of the item when the user purchases one

string

None.

VariantId

Unique identifier for the Product Variation that was ordered

string

None.

ShippingDetail

Shipping information container for the order

Shippingdetail

None.

IsWishExpress

Is a wish express order

string

None.

Cost

The amount of money paid for the product (per unit)

string

None.

ShippingCost

The amount of money paid for shipping the product (per unit)

string

None.

HoursToFulfill

hours left to fulfill order.

string

None.

RequiresDeliveryConfirmation

Order must be shipped using a carrier that has last mile tracking functionality

string

None.

ProductImageUrl

The product image

string

None.

Size

Ordered item size (if applicable)

string

None.

Sku

Unique item identifier for your system

string

None.

TrackingConfirmed

Tracking confirmation

string

None.

OrderTotal

Total value of the order

string

None.

ProductId

Unique identifier for the Product being ordered

string

None.

Shipping

Amount of money user pays for shipping for the product(per unit)

string

None.

State

The status of the order: APPROVED, SHIPPED, REFUNDED, REQUIRE_REVIEW

string

None.

OrderTime

Date and time of when the order was placed

date

None.

DaysToFulfill

Number of days left to fulfill this order

string

None.

ProductName

Name of the product

string

None.

TransactionId

Orders unique grouping identifier to highlight if the user makes several purchases at once

string

None.

BuyerId

Identification of the buyer for this order.

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "OrderId": "sample string 1",
    "LastUpdated": "2024-03-29T01:40:51.96405Z",
    "ExpectedShipDate": "2024-03-29T01:40:51.96405Z",
    "Quantity": "sample string 4",
    "Color": "sample string 5",
    "Price": "sample string 6",
    "VariantId": "sample string 7",
    "ShippingDetail": {
      "PhoneNumber": "sample string 1",
      "City": "sample string 2",
      "State": "sample string 3",
      "Name": "sample string 4",
      "Country": "sample string 5",
      "StreetAddress2": "sample string 6",
      "StreetAddress1": "sample string 7",
      "Zipcode": "sample string 8"
    },
    "IsWishExpress": "sample string 8",
    "Cost": "sample string 9",
    "ShippingCost": "sample string 10",
    "HoursToFulfill": "sample string 11",
    "RequiresDeliveryConfirmation": "sample string 12",
    "ProductImageUrl": "sample string 13",
    "Size": "sample string 14",
    "Sku": "sample string 15",
    "TrackingConfirmed": "sample string 16",
    "OrderTotal": "sample string 17",
    "ProductId": "sample string 18",
    "Shipping": "sample string 19",
    "State": "sample string 20",
    "OrderTime": "2024-03-29T01:40:51.96405Z",
    "DaysToFulfill": "sample string 22",
    "ProductName": "sample string 23",
    "TransactionId": "sample string 24",
    "BuyerId": "sample string 25"
  },
  {
    "OrderId": "sample string 1",
    "LastUpdated": "2024-03-29T01:40:51.96405Z",
    "ExpectedShipDate": "2024-03-29T01:40:51.96405Z",
    "Quantity": "sample string 4",
    "Color": "sample string 5",
    "Price": "sample string 6",
    "VariantId": "sample string 7",
    "ShippingDetail": {
      "PhoneNumber": "sample string 1",
      "City": "sample string 2",
      "State": "sample string 3",
      "Name": "sample string 4",
      "Country": "sample string 5",
      "StreetAddress2": "sample string 6",
      "StreetAddress1": "sample string 7",
      "Zipcode": "sample string 8"
    },
    "IsWishExpress": "sample string 8",
    "Cost": "sample string 9",
    "ShippingCost": "sample string 10",
    "HoursToFulfill": "sample string 11",
    "RequiresDeliveryConfirmation": "sample string 12",
    "ProductImageUrl": "sample string 13",
    "Size": "sample string 14",
    "Sku": "sample string 15",
    "TrackingConfirmed": "sample string 16",
    "OrderTotal": "sample string 17",
    "ProductId": "sample string 18",
    "Shipping": "sample string 19",
    "State": "sample string 20",
    "OrderTime": "2024-03-29T01:40:51.96405Z",
    "DaysToFulfill": "sample string 22",
    "ProductName": "sample string 23",
    "TransactionId": "sample string 24",
    "BuyerId": "sample string 25"
  }
]