Get a single order worksheet.

GET

/orders/{direction}/{orderID}/worksheet

200

Roles

At least one of the roles below is required to access this endpoint.

FullAccessIntegrationEventAdminOrderAdminShopperOrderReader

Parameters

Name		Type	Description	Possible Values
direction	Required	`string`	Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.	Incoming, Outgoing, All
orderID	Required	`string`	ID of the order.	---

Response Body

Property Type Format Max Length Possible Values

Order object --- --- ---

Property Type Format Max Length Possible Values

ID string --- 100 characters ---

FromUser

Read Only

object

---

FromCompanyID

string

---

ToCompanyID

string

---

FromUserID

string

---

BillingAddressID string --- --- ---

BillingAddress Read Only object --- --- ---

ShippingAddressID

string

---

Comments string --- 2000 characters ---

LineItemCount Read Only integer int32 --- ---

Status Read Only string --- --- Unsubmitted, AwaitingApproval, Declined, Open, Completed, Canceled

DateCreated Read Only string date-time --- ---

DateSubmitted

Read Only

string

date-time

---

DateApproved Read Only string date-time --- ---

DateDeclined Read Only string date-time --- ---

DateCanceled Read Only string date-time --- ---

DateCompleted

Read Only

string

date-time

---

LastUpdated Read Only string date-time --- ---

Subtotal

Read Only

number

float

---

ShippingCost

number

float

---

TaxCost

number

float

---

PromotionDiscount

Read Only

number

float

---

Currency

Read Only

string

---

Total

Read Only

number

float

---

IsSubmitted

Read Only

boolean

---

SubscriptionID

Read Only

string

---

xp object --- --- ---

LineItems array --- --- ---

Property Type Format Max Length Possible Values

ID string --- 100 characters ---

ProductID string --- --- ---

Quantity integer int32 --- ---

BundleItemID

Read Only

string

---

IsBundle

Read Only

boolean

---

DateAdded Read Only string date-time --- ---

QuantityShipped

Read Only

integer

int32

---

UnitPrice

number

float

---

PromotionDiscount

Read Only

number

float

---

LineTotal

Read Only

number

float

---

LineSubtotal

Read Only

number

float

---

CostCenter

string

---

DateNeeded string date-time --- ---

ShippingAccount

string

---

ShippingAddressID string --- --- ---

ShipFromAddressID

string

---

Product Read Only object --- --- ---

Variant Read Only object --- --- ---

ShippingAddress Read Only object --- --- ---

ShipFromAddress Read Only object --- --- ---

SupplierID Read Only string --- --- ---

InventoryRecordID

string

---

PriceScheduleID

Read Only

string

---

IsOnSale

Read Only

boolean

---

PriceOverridden

Read Only

boolean

---

Specs array --- --- ---

IncomingOrderID

Read Only

string

---

OutgoingOrderID

Read Only

string

---

xp object --- --- ---

OrderPromotions array --- --- ---

Subscription object --- --- ---

ShipEstimateResponse object --- --- ---

OrderCalculateResponse object --- --- ---

OrderSubmitResponse object --- --- ---

OrderSubmitForApprovalResponse object --- --- ---

OrderApprovedResponse object --- --- ---

SubscriptionIntegrationResponse object --- --- ---

Get a single order worksheet.

GET

/orders/{direction}/{orderID}/worksheet

200

Roles

At least one of the roles below is required to access this endpoint.

FullAccessIntegrationEventAdminOrderAdminShopperOrderReader

Parameters

Name		Type	Description	Possible Values
direction	Required	`string`	Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.	Incoming, Outgoing, All
orderID	Required	`string`	ID of the order.	---

Response Body

Property Type Format Max Length Possible Values

Order object --- --- ---

Property Type Format Max Length Possible Values

ID string --- 100 characters ---

FromUser

Read Only

object

---

FromCompanyID

string

---

ToCompanyID

string

---

FromUserID

string

---

BillingAddressID string --- --- ---

BillingAddress Read Only object --- --- ---

ShippingAddressID

string

---

Comments string --- 2000 characters ---

LineItemCount Read Only integer int32 --- ---

Status Read Only string --- --- Unsubmitted, AwaitingApproval, Declined, Open, Completed, Canceled

DateCreated Read Only string date-time --- ---

DateSubmitted

Read Only

string

date-time

---

DateApproved Read Only string date-time --- ---

DateDeclined Read Only string date-time --- ---

DateCanceled Read Only string date-time --- ---

DateCompleted

Read Only

string

date-time

---

LastUpdated Read Only string date-time --- ---

Subtotal

Read Only

number

float

---

ShippingCost

number

float

---

TaxCost

number

float

---

PromotionDiscount

Read Only

number

float

---

Currency

Read Only

string

---

Total

Read Only

number

float

---

IsSubmitted

Read Only

boolean

---

SubscriptionID

Read Only

string

---

xp object --- --- ---

LineItems array --- --- ---

Property Type Format Max Length Possible Values

ID string --- 100 characters ---

ProductID string --- --- ---

Quantity integer int32 --- ---

BundleItemID

Read Only

string

---

IsBundle

Read Only

boolean

---

DateAdded Read Only string date-time --- ---

QuantityShipped

Read Only

integer

int32

---

UnitPrice

number

float

---

PromotionDiscount

Read Only

number

float

---

LineTotal

Read Only

number

float

---

LineSubtotal

Read Only

number

float

---

CostCenter

string

---

DateNeeded string date-time --- ---

ShippingAccount

string

---

ShippingAddressID string --- --- ---

ShipFromAddressID

string

---

Product Read Only object --- --- ---

Variant Read Only object --- --- ---

ShippingAddress Read Only object --- --- ---

ShipFromAddress Read Only object --- --- ---

SupplierID Read Only string --- --- ---

InventoryRecordID

string

---

PriceScheduleID

Read Only

string

---

IsOnSale

Read Only

boolean

---

PriceOverridden

Read Only

boolean

---

Specs array --- --- ---

IncomingOrderID

Read Only

string

---

OutgoingOrderID

Read Only

string

---

xp object --- --- ---

OrderPromotions array --- --- ---

Subscription object --- --- ---

ShipEstimateResponse object --- --- ---

OrderCalculateResponse object --- --- ---

OrderSubmitResponse object --- --- ---

OrderSubmitForApprovalResponse object --- --- ---

OrderApprovedResponse object --- --- ---

SubscriptionIntegrationResponse object --- --- ---