Class Shipments

Hierarchy

Shipments

Index

Properties

impersonating

Methods

As Create Delete DeleteItem Get GetItem List ListItems Patch Save SaveItem SetShipFromAddress SetShipToAddress

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

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

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

Create

Create<TShipment>(shipment: Shipment<any, any, any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TShipment>>
Create a new shipment. 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
- TShipment extends Shipment<any, any, any, TShipment>
Parameters
- shipment: Shipment<any, any, any>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TShipment>>
- Defined in api/Shipments.ts:72

Delete

Delete(shipmentID: string, requestOptions?: RequestOptions): Promise<void>
Delete a shipment. Check out the docs for more info
Parameters
- shipmentID: string
  
  ID of the shipment.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Shipments.ts:136

DeleteItem

DeleteItem(shipmentID: string, orderID: string, lineItemID: string, requestOptions?: RequestOptions): Promise<void>
Delete a shipment item. Check out the docs for more info
Parameters
- shipmentID: string
  
  ID of the shipment.
- orderID: string
  
  ID of the order.
- lineItemID: string
  
  ID of the line item.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Shipments.ts:250

Get

Get<TShipment>(shipmentID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TShipment>>
Get a single shipment. Check out the docs for more info
Type Parameters
- TShipment extends Shipment<any, any, any, TShipment>
Parameters
- shipmentID: string
  
  ID of the shipment.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TShipment>>
- Defined in api/Shipments.ts:93

GetItem

GetItem<TShipmentItem>(shipmentID: string, orderID: string, lineItemID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TShipmentItem>>
Get a single shipment item. Check out the docs for more info
Type Parameters
- TShipmentItem extends ShipmentItem<any, any, any, TShipmentItem>
Parameters
- shipmentID: string
  
  ID of the shipment.
- orderID: string
  
  ID of the order.
- lineItemID: string
  
  ID of the line item.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TShipmentItem>>
- Defined in api/Shipments.ts:227

List

List<TShipment>(listOptions?: {
    filters?: Filters;
    orderID?: string;
    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>>>
Get a list of shipments. Check out the docs for more info
Type Parameters
- TShipment extends Shipment<any, any, any, TShipment>
Parameters
- listOptions: {
      filters?: Filters;
      orderID?: string;
      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 orderID?: string
    
    ID of the order.
  - 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/Shipments.ts:51

ListItems

ListItems<TShipmentItem>(shipmentID: string, listOptions?: {
    filters?: Filters;
    page?: number;
    pageSize?: number;
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TShipmentItem>>>
Get a list of shipment items. Check out the docs for more info
Type Parameters
- TShipmentItem extends ShipmentItem<any, any, any, TShipmentItem>
Parameters
- shipmentID: string
  
  ID of the shipment.
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
  } = {}
  - 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.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TShipmentItem>>>
- Defined in api/Shipments.ts:182

Patch

Patch<TShipment>(shipmentID: string, shipment: PartialObjectDeep<Shipment<any, any, any>>, requestOptions?: RequestOptions): Promise<RequiredDeep<TShipment>>
Partially update a shipment. Check out the docs for more info
Type Parameters
- TShipment extends Shipment<any, any, any, TShipment>
Parameters
- shipmentID: string
  
  ID of the shipment.
- shipment: PartialObjectDeep<Shipment<any, any, any>>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TShipment>>
- Defined in api/Shipments.ts:158

Save

Save<TShipment>(shipmentID: string, shipment: Shipment<any, any, any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TShipment>>
Create or update a shipment. If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TShipment extends Shipment<any, any, any, TShipment>
Parameters
- shipmentID: string
  
  ID of the shipment.
- shipment: Shipment<any, any, any>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TShipment>>
- Defined in api/Shipments.ts:115

SaveItem

SaveItem<TShipmentItem>(shipmentID: string, shipmentItem: ShipmentItem<any, any, any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TShipmentItem>>
Create or update a shipment item. Check out the docs for more info
Type Parameters
- TShipmentItem extends ShipmentItem<any, any, any, TShipmentItem>
Parameters
- shipmentID: string
  
  ID of the shipment.
- shipmentItem: ShipmentItem<any, any, any>
  
  Required fields: OrderID, LineItemID, QuantityShipped
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TShipmentItem>>
- Defined in api/Shipments.ts:204

SetShipFromAddress

SetShipFromAddress<TShipment>(shipmentID: string, address: Address<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TShipment>>
Set a ship from 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 shipment's FromAddressID property instead. Check out the docs for more info
Type Parameters
- TShipment extends Shipment<any, any, any, TShipment>
Parameters
- shipmentID: string
  
  ID of the shipment.
- address: Address<any>
  
  Required fields: Street1, City, State, Zip, Country
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TShipment>>
- Defined in api/Shipments.ts:272

SetShipToAddress

SetShipToAddress<TShipment>(shipmentID: string, address: Address<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TShipment>>
Set a ship to 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 shipment's ToAddressID property instead. Check out the docs for more info
Type Parameters
- TShipment extends Shipment<any, any, any, TShipment>
Parameters
- shipmentID: string
  
  ID of the shipment.
- address: Address<any>
  
  Required fields: Street1, City, State, Zip, Country
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TShipment>>
- Defined in api/Shipments.ts:294

Class Shipments

Hierarchy

Index

Properties

Methods

Properties

Private impersonating

Methods

As

Description

Example

Returns Shipments

Create

Type Parameters

TShipment extends Shipment<any, any, any, TShipment>

Parameters

shipment: Shipment<any, any, any>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TShipment>>

Delete

Parameters

shipmentID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

DeleteItem

Parameters

shipmentID: string

orderID: string

lineItemID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

Get

Type Parameters

TShipment extends Shipment<any, any, any, TShipment>

Parameters

shipmentID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TShipment>>

GetItem

Type Parameters

TShipmentItem extends ShipmentItem<any, any, any, TShipmentItem>

Parameters

shipmentID: string

orderID: string

lineItemID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TShipmentItem>>

List

Type Parameters

TShipment extends Shipment<any, any, any, TShipment>

Parameters

Optional filters?: Filters

Optional orderID?: string

Optional page?: number

Optional pageSize?: number

Optional search?: string

Optional searchOn?: ("ID" | "BuyerID" | "Shipper" | "DateShipped" | "DateDelivered" | "TrackingNumber")[]

Optional sortBy?: ("ID" | "BuyerID" | "Shipper" | "DateShipped" | "DateDelivered" | "!ID" | "OwnerID" | "!OwnerID" | "!BuyerID" | "Cost" | "!DateShipped" | "!Shipper" | "!DateDelivered" | "!Cost")[]

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TShipment>>>

ListItems

Type Parameters

TShipmentItem extends ShipmentItem<any, any, any, TShipmentItem>

Parameters

shipmentID: string

listOptions: { filters?: Filters; page?: number; pageSize?: number; } = {}

Optional filters?: Filters

Optional page?: number

Optional pageSize?: number

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TShipmentItem>>>

Patch

Type Parameters

TShipment extends Shipment<any, any, any, TShipment>

Parameters

shipmentID: string

shipment: PartialObjectDeep<Shipment<any, any, any>>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TShipment>>

Save

`Private` impersonating

`Optional` filters?: Filters

`Optional` orderID?: string

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

`Optional` searchOn?: ("ID" | "BuyerID" | "Shipper" | "DateShipped" | "DateDelivered" | "TrackingNumber")[]

`Optional` sortBy?: ("ID" | "BuyerID" | "Shipper" | "DateShipped" | "DateDelivered" | "!ID" | "OwnerID" | "!OwnerID" | "!BuyerID" | "Cost" | "!DateShipped" | "!Shipper" | "!DateDelivered" | "!Cost")[]

listOptions: {
filters?: Filters;
page?: number;
pageSize?: number;
} = {}

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number