/api/v1/orders

get https://dogfood.commerce.insitesandbox.com/api/v1/orders

New Requests

time	status	user agent
Retrieving recent requests…

Loading…

Response

Response body

object

uri

string

orders

array of objects

orders

object

uri

string

erpOrderNumber

string

webOrderNumber

string

orderDate

date-time

status

string

statusDisplay

string

customerNumber

string

customerSequence

string

customerPO

string

currencyCode

string

currencySymbol

string

terms

string

shipCode

string

salesperson

string

btCompanyName

string

btAddress1

string

btAddress2

string

btAddress3

string

btAddress4

string

billToCity

string

billToState

string

billToPostalCode

string

btCountry

string

stCompanyName

string

stAddress1

string

stAddress2

string

stAddress3

string

stAddress4

string

shipToCity

string

shipToState

string

shipToPostalCode

string

stCountry

string

notes

string

productTotal

number

orderSubTotal

number

discountAmount

number

orderDiscountAmount

number

productDiscountAmount

number

shippingAndHandling

number

shippingCharges

number

handlingCharges

number

otherCharges

number

taxAmount

number

orderTotal

number

modifyDate

date-time

requestedDeliveryDateDisplay

date-time

orderLines

array of objects

orderLines

object

uri

string

productId

string

productUri

string

mediumImagePath

string

altText

string

productName

string

manufacturerItem

string

customerName

string

shortDescription

string

productErpNumber

string

customerProductNumber

string

requiredDate

date-time

lastShipDate

date-time

customerNumber

string

customerSequence

string

lineType

string

status

string

lineNumber

number

releaseNumber

number

linePOReference

string

description

string

warehouse

string

notes

string

qtyOrdered

number

qtyShipped

number

unitOfMeasure

string

unitOfMeasureDisplay

string

unitOfMeasureDescription

string

availability

object

inventoryQtyOrdered

number

inventoryQtyShipped

number

unitPrice

number

unitNetPrice

number

extendedUnitNetPrice

number

discountPercent

number

discountAmount

number

unitDiscountAmount

number

promotionAmountApplied

number

totalDiscountAmount

number

lineTotal

number

totalRegularPrice

number

unitListPrice

number

unitRegularPrice

number

unitCost

number

orderLineOtherCharges

number

taxRate

number

taxAmount

number

returnReason

string

rmaQtyRequested

number

rmaQtyReceived

number

unitPriceDisplay

string

unitNetPriceDisplay

string

extendedUnitNetPriceDisplay

string

discountAmountDisplay

string

unitDiscountAmountDisplay

string

promotionAmountAppliedDisplay

string

totalDiscountAmountDisplay

string

lineTotalDisplay

string

totalRegularPriceDisplay

string

unitListPriceDisplay

string

unitRegularPriceDisplay

string

unitCostDisplay

string

orderLineOtherChargesDisplay

string

costCode

string

canAddToCart

boolean

isActiveProduct

boolean

sectionOptions

array of objects

sectionOptions

object

sectionOptionId

string

sectionName

string

optionName

string

salePriceLabel

string

canAddToWishlist

boolean

brand

object

netPriceWithVat

number

netPriceWithVatDisplay

string

unitPriceWithVat

number

unitPriceWithVatDisplay

string

vmiBinNumber

string

vmiBinId

string

isActiveVmiBin

boolean

isDiscontinued

boolean

properties

object

Has additional fields

orderPromotions

array of objects

orderPromotions

object

uri

string

amount

double

amountDisplay

string

name

string

orderHistoryLineId

string

promotionResultType

string

properties

object

Has additional fields

shipmentPackages

array of objects

shipmentPackages

object

string

shipmentDate

date-time

packageNumber

string

carrier

string

shipVia

string

trackingUrl

string

trackingNumber

string

packSlip

string

shipmentPackageLineDtos

array of objects

shipmentPackageLineDtos

object

string

productName

string

productDescription

string

productCode

string

qtyOrdered

number

qtyShipped

number

price

number

orderLineId

string

returnReasons

array of strings

returnReasons

orderHistoryTaxes

array of objects

orderHistoryTaxes

object

taxCode

string

taxDescription

string

taxRate

number

taxAmount

number

taxAmountDisplay

string

sortOrder

int32

productTotalDisplay

string

orderSubTotalDisplay

string

orderTotalDisplay

string

orderGrandTotalDisplay

string

discountAmountDisplay

string

orderDiscountAmountDisplay

string

productDiscountAmountDisplay

string

taxAmountDisplay

string

totalTaxDisplay

string

shippingAndHandlingDisplay

string

shippingChargesDisplay

string

handlingChargesDisplay

string

otherChargesDisplay

string

canAddToCart

boolean

canAddAllToCart

boolean

showTaxAndShipping

boolean

shipViaDescription

string

fulfillmentMethod

string

customerVatNumber

string

vmiLocationId

string

vmiLocationName

string

properties

object

Has additional fields

pagination

object

currentPage

int32

page

int32

pageSize

int32

defaultPageSize

int32

totalItemCount

int32

numberOfPages

int32

pageSizeOptions

array of int32s

pageSizeOptions

sortOptions

array of objects

sortOptions

object

displayName

string

sortType

string

sortType

string

nextPageUri

string

prevPageUri

string

nextPageToken

string

showErpOrderNumber

boolean

properties

object

Has additional fields

Language

Credentials

Query


xxxxxxxxxx
1
curl --request GET \
2
     --url https://dogfood.commerce.insitesandbox.com/api/v1/orders \
3
     --header 'accept: application/json'

Select from the Examples drop-down list.

200OK