Class Orders

Hierarchy

Orders

Properties

`Private` impersonating

impersonating: boolean = false

Methods

AddPromotion

AddPromotion<TOrderPromotion>(direction: OrderDirection, orderID: string, promoCode: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrderPromotion>>
Add a promotion to an order. Check out the docs for more info
Type Parameters
- TOrderPromotion extends OrderPromotion<any, TOrderPromotion>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- promoCode: string
  
  Promo code of the order promotion.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrderPromotion>>
- Defined in api/Orders.ts:530

ApplyPromotions

ApplyPromotions<TOrder>(direction: OrderDirection, orderID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrder>>
AutoApply eligible promotions. Apply up to 100 eligible promotions to an order. Check out the docs for more info
Type Parameters
- TOrder extends Order<any, any, any, TOrder>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrder>>
- Defined in api/Orders.ts:214

Approve

Approve<TOrder>(direction: OrderDirection, orderID: string, orderApprovalInfo: OrderApprovalInfo, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrder>>
Approve an order. Check out the docs for more info
Type Parameters
- TOrder extends Order<any, any, any, TOrder>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- orderApprovalInfo: OrderApprovalInfo
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrder>>
- Defined in api/Orders.ts:265

As

As(): Orders
Description
enables impersonation by calling the subsequent method with the stored impersonation token

Example
```
Orders.As().List() // lists Orders using the impersonated users' token
```
Returns Orders
- Defined in api/Orders.ts:735

Cancel

Cancel<TOrder>(direction: OrderDirection, orderID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrder>>
Cancel an order. Check out the docs for more info
Type Parameters
- TOrder extends Order<any, any, any, TOrder>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrder>>
- Defined in api/Orders.ts:333

Complete

Complete<TOrder>(direction: OrderDirection, orderID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrder>>
Complete an order. Use only when an order doesn't need a shipment. You will not be able to ship or reopen an order after completing it. Check out the docs for more info
Type Parameters
- TOrder extends Order<any, any, any, TOrder>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrder>>
- Defined in api/Orders.ts:355

Create

Create<TOrder>(direction: OrderDirection, order: Order<any, any, any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrder>>
Create a new order. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. Check out the docs for more info
Type Parameters
- TOrder extends Order<any, any, any, TOrder>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- order: Order<any, any, any>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrder>>
- Defined in api/Orders.ts:102

Decline

Decline<TOrder>(direction: OrderDirection, orderID: string, orderApprovalInfo: OrderApprovalInfo, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrder>>
Decline an order. Check out the docs for more info
Type Parameters
- TOrder extends Order<any, any, any, TOrder>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- orderApprovalInfo: OrderApprovalInfo
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrder>>
- Defined in api/Orders.ts:378

Delete

Delete(direction: OrderDirection, orderID: string, requestOptions?: RequestOptions): Promise<void>
Delete an order. Check out the docs for more info
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Orders.ts:169

Forward

Forward<TOrderSplitResult>(direction: OrderDirection, orderID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrderSplitResult>>
Forward an order. Creates and submits 0 or more outgoing Orders to Suppliers, one for each unique Product.DefaultSupplierID on this Order. Check out the docs for more info
Type Parameters
- TOrderSplitResult extends OrderSplitResult<any, any, any, TOrderSplitResult>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrderSplitResult>>
- Defined in api/Orders.ts:456

Get

Get<TOrder>(direction: OrderDirection, orderID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrder>>
Get a single order. Check out the docs for more info
Type Parameters
- TOrder extends Order<any, any, any, TOrder>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrder>>
- Defined in api/Orders.ts:124

List

List<TOrder>(direction: OrderDirection, listOptions?: {
    buyerID?: string;
    filters?: Filters;
    from?: string;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Comments")[];
    searchType?: SearchType;
    sortBy?: ("ID" | "FromCompanyID" | "ToCompanyID" | "DateCreated" | "!ID" | "!DateCreated" | "DateSubmitted" | "FromUserID" | "Status" | "DateApproved" | "DateDeclined" | "DateCanceled" | "DateCompleted" | "LastUpdated" | "Subtotal" | "ShippingCost" | "TaxCost" | "PromotionDiscount" | "Total" | "IsSubmitted" | "!DateSubmitted" | "!FromCompanyID" | "!ToCompanyID" | "!FromUserID" | "!Status" | "!DateApproved" | "!DateDeclined" | "!DateCanceled" | "!DateCompleted" | "!LastUpdated" | "!Subtotal" | "!ShippingCost" | "!TaxCost" | "!PromotionDiscount" | "!Total" | "!IsSubmitted")[];
    supplierID?: string;
    to?: string;
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TOrder>>>
Get a list of orders. Check out the docs for more info
Type Parameters
- TOrder extends Order<any, any, any, TOrder>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- listOptions: {
      buyerID?: string;
      filters?: Filters;
      from?: string;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Comments")[];
      searchType?: SearchType;
      sortBy?: ("ID" | "FromCompanyID" | "ToCompanyID" | "DateCreated" | "!ID" | "!DateCreated" | "DateSubmitted" | "FromUserID" | "Status" | "DateApproved" | "DateDeclined" | "DateCanceled" | "DateCompleted" | "LastUpdated" | "Subtotal" | "ShippingCost" | "TaxCost" | "PromotionDiscount" | "Total" | "IsSubmitted" | "!DateSubmitted" | "!FromCompanyID" | "!ToCompanyID" | "!FromUserID" | "!Status" | "!DateApproved" | "!DateDeclined" | "!DateCanceled" | "!DateCompleted" | "!LastUpdated" | "!Subtotal" | "!ShippingCost" | "!TaxCost" | "!PromotionDiscount" | "!Total" | "!IsSubmitted")[];
      supplierID?: string;
      to?: string;
  } = {}
  - Optional buyerID?: string
    
    ID of the buyer.
  - Optional filters?: Filters
    
    An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
  - Optional from?: string
    
    Lower bound of date range that the order was created.
  - Optional page?: number
    
    Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page. Default: 20, max: 100.
  - Optional search?: string
    
    Word or phrase to search for.
  - Optional searchOn?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Comments")[]
    
    Comma-delimited list of fields to search on.
  - Optional searchType?: SearchType
    
    Type of search to perform. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix.
  - Optional sortBy?: ("ID" | "FromCompanyID" | "ToCompanyID" | "DateCreated" | "!ID" | "!DateCreated" | "DateSubmitted" | "FromUserID" | "Status" | "DateApproved" | "DateDeclined" | "DateCanceled" | "DateCompleted" | "LastUpdated" | "Subtotal" | "ShippingCost" | "TaxCost" | "PromotionDiscount" | "Total" | "IsSubmitted" | "!DateSubmitted" | "!FromCompanyID" | "!ToCompanyID" | "!FromUserID" | "!Status" | "!DateApproved" | "!DateDeclined" | "!DateCanceled" | "!DateCompleted" | "!LastUpdated" | "!Subtotal" | "!ShippingCost" | "!TaxCost" | "!PromotionDiscount" | "!Total" | "!IsSubmitted")[]
    
    Comma-delimited list of fields to sort by.
  - Optional supplierID?: string
    
    ID of the supplier.
  - Optional to?: string
    
    Upper bound of date range that the order was created.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TOrder>>>
- Defined in api/Orders.ts:80

ListApprovals

ListApprovals<TOrderApproval>(direction: OrderDirection, orderID: string, listOptions?: {
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: ("Comments" | "ApprovalRuleID" | "ApprovingGroupID" | "Approver")[];
    sortBy?: ("ApprovalRuleID" | "ApprovingGroupID" | "Approver" | "DateCreated" | "!DateCreated" | "!ApprovingGroupID" | "Status" | "DateCompleted" | "!Status" | "!DateCompleted" | "!ApprovalRuleID" | "!Approver" | "AllowResubmit" | "!AllowResubmit")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TOrderApproval>>>
Get a list of order approvals. Returns all Approvals associated with the Order. Check out the docs for more info
Type Parameters
- TOrderApproval extends OrderApproval<any, TOrderApproval>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("Comments" | "ApprovalRuleID" | "ApprovingGroupID" | "Approver")[];
      sortBy?: ("ApprovalRuleID" | "ApprovingGroupID" | "Approver" | "DateCreated" | "!DateCreated" | "!ApprovingGroupID" | "Status" | "DateCompleted" | "!Status" | "!DateCompleted" | "!ApprovalRuleID" | "!Approver" | "AllowResubmit" | "!AllowResubmit")[];
  } = {}
  - Optional filters?: Filters
    
    An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
  - Optional page?: number
    
    Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page. Default: 20, max: 100.
  - Optional search?: string
    
    Word or phrase to search for.
  - Optional searchOn?: ("Comments" | "ApprovalRuleID" | "ApprovingGroupID" | "Approver")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ApprovalRuleID" | "ApprovingGroupID" | "Approver" | "DateCreated" | "!DateCreated" | "!ApprovingGroupID" | "Status" | "DateCompleted" | "!Status" | "!DateCompleted" | "!ApprovalRuleID" | "!Approver" | "AllowResubmit" | "!AllowResubmit")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TOrderApproval>>>
- Defined in api/Orders.ts:242

ListEligibleApprovers

ListEligibleApprovers<TUser>(direction: OrderDirection, orderID: string, listOptions?: {
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: ("ID" | "LastName" | "FirstName" | "Username" | "Email")[];
    sortBy?: ("ID" | "LastName" | "FirstName" | "Username" | "Email" | "DateCreated" | "!ID" | "!DateCreated" | "!FirstName" | "!LastName" | "PasswordLastSetDate" | "!Username" | "!Email" | "!PasswordLastSetDate")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TUser>>>
Get a list of order eligible approvers. Returns all Users who can approve or decline this order (but have not done so). Check out the docs for more info
Type Parameters
- TUser extends User<any, TUser>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "LastName" | "FirstName" | "Username" | "Email")[];
      sortBy?: ("ID" | "LastName" | "FirstName" | "Username" | "Email" | "DateCreated" | "!ID" | "!DateCreated" | "!FirstName" | "!LastName" | "PasswordLastSetDate" | "!Username" | "!Email" | "!PasswordLastSetDate")[];
  } = {}
  - Optional filters?: Filters
    
    An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
  - Optional page?: number
    
    Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page. Default: 20, max: 100.
  - Optional search?: string
    
    Word or phrase to search for.
  - Optional searchOn?: ("ID" | "LastName" | "FirstName" | "Username" | "Email")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ID" | "LastName" | "FirstName" | "Username" | "Email" | "DateCreated" | "!ID" | "!DateCreated" | "!FirstName" | "!LastName" | "PasswordLastSetDate" | "!Username" | "!Email" | "!PasswordLastSetDate")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TUser>>>
- Defined in api/Orders.ts:406

ListEligiblePromotions

ListEligiblePromotions<TPromotion>(direction: OrderDirection, orderID: string, listOptions?: {
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: ("ID" | "Name" | "Description" | "Code" | "FinePrint" | "EligibleExpression" | "ValueExpression")[];
    sortBy?: ("ID" | "Name" | "ExpirationDate" | "Code" | "EligibleExpression" | "ValueExpression" | "!ID" | "!Name" | "!ExpirationDate" | "StartDate" | "CanCombine" | "AutoApply" | "Active" | "Priority" | "!Code" | "!StartDate" | "!EligibleExpression" | "!ValueExpression" | "!CanCombine" | "!AutoApply" | "!Active" | "!Priority")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TPromotion>>>
List eligible promotions. Get a list of promotions eligible for an order. Check out the docs for more info
Type Parameters
- TPromotion extends Promotion<any, TPromotion>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name" | "Description" | "Code" | "FinePrint" | "EligibleExpression" | "ValueExpression")[];
      sortBy?: ("ID" | "Name" | "ExpirationDate" | "Code" | "EligibleExpression" | "ValueExpression" | "!ID" | "!Name" | "!ExpirationDate" | "StartDate" | "CanCombine" | "AutoApply" | "Active" | "Priority" | "!Code" | "!StartDate" | "!EligibleExpression" | "!ValueExpression" | "!CanCombine" | "!AutoApply" | "!Active" | "!Priority")[];
  } = {}
  - Optional filters?: Filters
    
    An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
  - Optional page?: number
    
    Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page. Default: 20, max: 100.
  - Optional search?: string
    
    Word or phrase to search for.
  - Optional searchOn?: ("ID" | "Name" | "Description" | "Code" | "FinePrint" | "EligibleExpression" | "ValueExpression")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ID" | "Name" | "ExpirationDate" | "Code" | "EligibleExpression" | "ValueExpression" | "!ID" | "!Name" | "!ExpirationDate" | "StartDate" | "CanCombine" | "AutoApply" | "Active" | "Priority" | "!Code" | "!StartDate" | "!EligibleExpression" | "!ValueExpression" | "!CanCombine" | "!AutoApply" | "!Active" | "!Priority")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TPromotion>>>
- Defined in api/Orders.ts:434

ListPromotions

ListPromotions<TOrderPromotion>(direction: OrderDirection, orderID: string, listOptions?: {
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: ("ID" | "Name" | "Description" | "Code" | "FinePrint" | "EligibleExpression" | "ValueExpression")[];
    sortBy?: ("ID" | "Name" | "ExpirationDate" | "Code" | "EligibleExpression" | "ValueExpression" | "!ID" | "!Name" | "!ExpirationDate" | "StartDate" | "CanCombine" | "AutoApply" | "Active" | "Priority" | "!Code" | "!StartDate" | "!EligibleExpression" | "!ValueExpression" | "!CanCombine" | "!AutoApply" | "!Active" | "!Priority" | "DateApplied" | "!DateApplied")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TOrderPromotion>>>
Get a list of order promotions. Check out the docs for more info
Type Parameters
- TOrderPromotion extends OrderPromotion<any, TOrderPromotion>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name" | "Description" | "Code" | "FinePrint" | "EligibleExpression" | "ValueExpression")[];
      sortBy?: ("ID" | "Name" | "ExpirationDate" | "Code" | "EligibleExpression" | "ValueExpression" | "!ID" | "!Name" | "!ExpirationDate" | "StartDate" | "CanCombine" | "AutoApply" | "Active" | "Priority" | "!Code" | "!StartDate" | "!EligibleExpression" | "!ValueExpression" | "!CanCombine" | "!AutoApply" | "!Active" | "!Priority" | "DateApplied" | "!DateApplied")[];
  } = {}
  - Optional filters?: Filters
    
    An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
  - Optional page?: number
    
    Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page. Default: 20, max: 100.
  - Optional search?: string
    
    Word or phrase to search for.
  - Optional searchOn?: ("ID" | "Name" | "Description" | "Code" | "FinePrint" | "EligibleExpression" | "ValueExpression")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ID" | "Name" | "ExpirationDate" | "Code" | "EligibleExpression" | "ValueExpression" | "!ID" | "!Name" | "!ExpirationDate" | "StartDate" | "CanCombine" | "AutoApply" | "Active" | "Priority" | "!Code" | "!StartDate" | "!EligibleExpression" | "!ValueExpression" | "!CanCombine" | "!AutoApply" | "!Active" | "!Priority" | "DateApplied" | "!DateApplied")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TOrderPromotion>>>
- Defined in api/Orders.ts:507

ListShipments

ListShipments<TShipment>(direction: OrderDirection, orderID: string, listOptions?: {
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: ("ID" | "BuyerID" | "Shipper" | "DateShipped" | "DateDelivered" | "TrackingNumber")[];
    sortBy?: ("ID" | "BuyerID" | "Shipper" | "DateShipped" | "DateDelivered" | "!ID" | "OwnerID" | "!OwnerID" | "!BuyerID" | "Cost" | "!DateShipped" | "!Shipper" | "!DateDelivered" | "!Cost")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TShipment>>>
List shipments for an order. Check out the docs for more info
Type Parameters
- TShipment extends Shipment<any, any, any, TShipment>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "BuyerID" | "Shipper" | "DateShipped" | "DateDelivered" | "TrackingNumber")[];
      sortBy?: ("ID" | "BuyerID" | "Shipper" | "DateShipped" | "DateDelivered" | "!ID" | "OwnerID" | "!OwnerID" | "!BuyerID" | "Cost" | "!DateShipped" | "!Shipper" | "!DateDelivered" | "!Cost")[];
  } = {}
  - Optional filters?: Filters
    
    An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
  - Optional page?: number
    
    Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page. Default: 20, max: 100.
  - Optional search?: string
    
    Word or phrase to search for.
  - Optional searchOn?: ("ID" | "BuyerID" | "Shipper" | "DateShipped" | "DateDelivered" | "TrackingNumber")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ID" | "BuyerID" | "Shipper" | "DateShipped" | "DateDelivered" | "!ID" | "OwnerID" | "!OwnerID" | "!BuyerID" | "Cost" | "!DateShipped" | "!Shipper" | "!DateDelivered" | "!Cost")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TShipment>>>
- Defined in api/Orders.ts:604

Patch

Patch<TOrder>(direction: OrderDirection, orderID: string, order: PartialObjectDeep<Order<any, any, any>>, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrder>>
Partially update an order. Check out the docs for more info
Type Parameters
- TOrder extends Order<any, any, any, TOrder>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- order: PartialObjectDeep<Order<any, any, any>>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrder>>
- Defined in api/Orders.ts:192

PatchBillingAddress

PatchBillingAddress<TOrder>(direction: OrderDirection, orderID: string, address: PartialObjectDeep<Address<any>>, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrder>>
Partially update an order billing address. Not allowed on unsubmitted orders where BillingAddressID has been set. In that case, use the Addresses resource to update the saved address. Check out the docs for more info
Type Parameters
- TOrder extends Order<any, any, any, TOrder>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- address: PartialObjectDeep<Address<any>>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrder>>
- Defined in api/Orders.ts:311

PatchFromUser

PatchFromUser<TOrder>(direction: OrderDirection, orderID: string, user: PartialObjectDeep<User<any>>, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrder>>
Update order FromUser. Only FirstName, LastName, and Email can be updated.

Primarily used to facilitate guest checkout scenarios. Check out the docs for more info
Type Parameters
- TOrder extends Order<any, any, any, TOrder>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- user: PartialObjectDeep<User<any>>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrder>>
- Defined in api/Orders.ts:479

PatchShippingAddress

PatchShippingAddress<TOrder>(direction: OrderDirection, orderID: string, address: PartialObjectDeep<Address<any>>, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrder>>
Partially update an order shipping address. Not allowed on unsubmitted orders where ShippingAddressID has been set. In that case, use the Addresses resource to update the saved address. Check out the docs for more info
Type Parameters
- TOrder extends Order<any, any, any, TOrder>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- address: PartialObjectDeep<Address<any>>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrder>>
- Defined in api/Orders.ts:650

RemovePromotion

RemovePromotion<TOrder>(direction: OrderDirection, orderID: string, promoCode: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrder>>
Remove a promotion from an order. Check out the docs for more info
Type Parameters
- TOrder extends Order<any, any, any, TOrder>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- promoCode: string
  
  Promo code of the order.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrder>>
- Defined in api/Orders.ts:553

Save

Save<TOrder>(direction: OrderDirection, orderID: string, order: Order<any, any, any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrder>>
Create or update an order. If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TOrder extends Order<any, any, any, TOrder>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- order: Order<any, any, any>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrder>>
- Defined in api/Orders.ts:147

SetBillingAddress

SetBillingAddress<TOrder>(direction: OrderDirection, orderID: string, address: Address<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrder>>
Set a billing address. Use only when the address is not to be saved/reused.

To use a saved address (i.e. from the Addresses resource), PATCH the order's BillingAddressID property instead. Check out the docs for more info
Type Parameters
- TOrder extends Order<any, any, any, TOrder>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- address: Address<any>
  
  Required fields: Street1, City, State, Zip, Country
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrder>>
- Defined in api/Orders.ts:288

SetShippingAddress

SetShippingAddress<TOrder>(direction: OrderDirection, orderID: string, address: Address<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrder>>
Set a shipping address. Use only when the address is not to be saved/reused. To use a saved address (i.e. from the Addresses resource), PATCH the order's ShippingAddressID property instead. The address used will be populated on the ShippingAddress property of each LineItem. Check out the docs for more info
Type Parameters
- TOrder extends Order<any, any, any, TOrder>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- address: Address<any>
  
  Required fields: Street1, City, State, Zip, Country
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrder>>
- Defined in api/Orders.ts:627

Ship

Ship<TOrder>(direction: OrderDirection, orderID: string, shipment: Shipment<any, any, any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrder>>
Create a new shipment containing all items on an order. Check out the docs for more info
Type Parameters
- TOrder extends Order<any, any, any, TOrder>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- shipment: Shipment<any, any, any>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrder>>
- Defined in api/Orders.ts:576

Split

Split<TOrderSplitResult>(direction: OrderDirection, orderID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrderSplitResult>>
Split an order. Creates, but does not submit, 0 or more outgoing Orders to Suppliers, one for each unique Product.DefaultSupplierID on this Order. Check out the docs for more info
Type Parameters
- TOrderSplitResult extends OrderSplitResult<any, any, any, TOrderSplitResult>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrderSplitResult>>
- Defined in api/Orders.ts:672

Submit

Submit<TOrder>(direction: OrderDirection, orderID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TOrder>>
Submit an order. Check out the docs for more info
Type Parameters
- TOrder extends Order<any, any, any, TOrder>
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TOrder>>
- Defined in api/Orders.ts:694

Validate

Validate(direction: OrderDirection, orderID: string, requestOptions?: RequestOptions): Promise<void>
Validate an order in its current state. Check out the docs for more info
Parameters
- direction: OrderDirection
  
  Direction of the order, from the current user's perspective. Possible values: incoming, outgoing, all.
- orderID: string
  
  ID of the order.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Orders.ts:716

Class Orders

Hierarchy

Index

Properties

Methods

Properties

Private impersonating

Methods

AddPromotion

Type Parameters

TOrderPromotion extends OrderPromotion<any, TOrderPromotion>

Parameters

direction: OrderDirection

orderID: string

promoCode: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TOrderPromotion>>

ApplyPromotions

Type Parameters

TOrder extends Order<any, any, any, TOrder>

Parameters

direction: OrderDirection

orderID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TOrder>>

Approve

Type Parameters

TOrder extends Order<any, any, any, TOrder>

Parameters

direction: OrderDirection

orderID: string

orderApprovalInfo: OrderApprovalInfo

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TOrder>>

As

Description

Example

Returns Orders

Cancel

Type Parameters

TOrder extends Order<any, any, any, TOrder>

Parameters

direction: OrderDirection

orderID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TOrder>>

Complete

Type Parameters

TOrder extends Order<any, any, any, TOrder>

Parameters

direction: OrderDirection

orderID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TOrder>>

Create

Type Parameters

TOrder extends Order<any, any, any, TOrder>

Parameters

direction: OrderDirection

order: Order<any, any, any>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TOrder>>

Decline

Type Parameters

TOrder extends Order<any, any, any, TOrder>

Parameters

direction: OrderDirection

orderID: string

orderApprovalInfo: OrderApprovalInfo

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TOrder>>

Delete

Parameters

direction: OrderDirection

orderID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

Forward

Type Parameters

TOrderSplitResult extends OrderSplitResult<any, any, any, TOrderSplitResult>

`Private` impersonating

`Optional` buyerID?: string

`Optional` filters?: Filters

`Optional` from?: string

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

`Optional` searchOn?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Comments")[]

`Optional` searchType?: SearchType

`Optional` supplierID?: string

`Optional` to?: string

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

`Optional` searchOn?: ("Comments" | "ApprovalRuleID" | "ApprovingGroupID" | "Approver")[]

`Optional` sortBy?: ("ApprovalRuleID" | "ApprovingGroupID" | "Approver" | "DateCreated" | "!DateCreated" | "!ApprovingGroupID" | "Status" | "DateCompleted" | "!Status" | "!DateCompleted" | "!ApprovalRuleID" | "!Approver" | "AllowResubmit" | "!AllowResubmit")[]

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

`Optional` searchOn?: ("ID" | "LastName" | "FirstName" | "Username" | "Email")[]

`Optional` sortBy?: ("ID" | "LastName" | "FirstName" | "Username" | "Email" | "DateCreated" | "!ID" | "!DateCreated" | "!FirstName" | "!LastName" | "PasswordLastSetDate" | "!Username" | "!Email" | "!PasswordLastSetDate")[]

`Optional` filters?: Filters