Class InventoryRecords

Hierarchy

InventoryRecords

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

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

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

Create

Create<TInventoryRecord>(productID: string, inventoryRecord: InventoryRecord<any, any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TInventoryRecord>>
Create a new inventory record. 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
- TInventoryRecord extends InventoryRecord<any, any, TInventoryRecord>
Parameters
- productID: string
  
  ID of the product.
- inventoryRecord: InventoryRecord<any, any>
  
  Required fields: AddressID
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TInventoryRecord>>
- Defined in api/InventoryRecords.ts:79

CreateVariant

CreateVariant<TInventoryRecord>(productID: string, variantID: string, inventoryRecord: InventoryRecord<any, any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TInventoryRecord>>
Create a new variant inventory record. Check out the docs for more info
Type Parameters
- TInventoryRecord extends InventoryRecord<any, any, TInventoryRecord>
Parameters
- productID: string
  
  ID of the product.
- variantID: string
  
  ID of the variant.
- inventoryRecord: InventoryRecord<any, any>
  
  Required fields: AddressID
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TInventoryRecord>>
- Defined in api/InventoryRecords.ts:295

Delete

Delete(productID: string, inventoryRecordID: string, requestOptions?: RequestOptions): Promise<void>
Delete an inventory record. Check out the docs for more info
Parameters
- productID: string
  
  ID of the product.
- inventoryRecordID: string
  
  ID of the inventory record.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/InventoryRecords.ts:146

DeleteAssignment

DeleteAssignment(productID: string, inventoryRecordID: string, listOptions?: {
    buyerID?: string;
    userGroupID?: string;
    userID?: string;
}, requestOptions?: RequestOptions): Promise<void>
Delete an inventory record assignment. Check out the docs for more info
Parameters
- productID: string
  
  ID of the product.
- inventoryRecordID: string
  
  ID of the inventory record.
- listOptions: {
      buyerID?: string;
      userGroupID?: string;
      userID?: string;
  } = {}
  - Optional buyerID?: string
    
    ID of the buyer.
  - Optional userGroupID?: string
    
    ID of the user group.
  - Optional userID?: string
    
    ID of the user.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/InventoryRecords.ts:194

DeleteVariant

DeleteVariant(productID: string, variantID: string, inventoryRecordID: string, requestOptions?: RequestOptions): Promise<void>
Delete a variant inventory record. Check out the docs for more info
Parameters
- productID: string
  
  ID of the product.
- variantID: string
  
  ID of the variant.
- inventoryRecordID: string
  
  ID of the inventory record.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/InventoryRecords.ts:365

DeleteVariantAssignment

DeleteVariantAssignment(productID: string, variantID: string, inventoryRecordID: string, listOptions?: {
    buyerID?: string;
    userGroupID?: string;
    userID?: string;
}, requestOptions?: RequestOptions): Promise<void>
Delete an inventory record variant assignment. Check out the docs for more info
Parameters
- productID: string
  
  ID of the product.
- variantID: string
  
  ID of the variant.
- inventoryRecordID: string
  
  ID of the inventory record.
- listOptions: {
      buyerID?: string;
      userGroupID?: string;
      userID?: string;
  } = {}
  - Optional buyerID?: string
    
    ID of the buyer.
  - Optional userGroupID?: string
    
    ID of the user group.
  - Optional userID?: string
    
    ID of the user.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/InventoryRecords.ts:415

Get

Get<TInventoryRecord>(productID: string, inventoryRecordID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TInventoryRecord>>
Get a single inventory record. Check out the docs for more info
Type Parameters
- TInventoryRecord extends InventoryRecord<any, any, TInventoryRecord>
Parameters
- productID: string
  
  ID of the product.
- inventoryRecordID: string
  
  ID of the inventory record.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TInventoryRecord>>
- Defined in api/InventoryRecords.ts:101

GetVariant

GetVariant<TInventoryRecord>(productID: string, variantID: string, inventoryRecordID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TInventoryRecord>>
Get a single variant inventory record. Check out the docs for more info
Type Parameters
- TInventoryRecord extends InventoryRecord<any, any, TInventoryRecord>
Parameters
- productID: string
  
  ID of the product.
- variantID: string
  
  ID of the variant.
- inventoryRecordID: string
  
  ID of the inventory record.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TInventoryRecord>>
- Defined in api/InventoryRecords.ts:318

List

List<TInventoryRecord>(productID: string, listOptions?: {
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: ("ID" | "AddressID")[];
    sortBy?: ("ID" | "AddressID" | "!ID" | "!AddressID")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TInventoryRecord>>>
Get a list of inventory records. Check out the docs for more info
Type Parameters
- TInventoryRecord extends InventoryRecord<any, any, TInventoryRecord>
Parameters
- productID: string
  
  ID of the product.
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "AddressID")[];
      sortBy?: ("ID" | "AddressID" | "!ID" | "!AddressID")[];
  } = {}
  - 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" | "AddressID")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ID" | "AddressID" | "!ID" | "!AddressID")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TInventoryRecord>>>
- Defined in api/InventoryRecords.ts:57

ListAssignments

ListAssignments<TInventoryRecordAssignment>(productID: string, listOptions?: {
    buyerID?: string;
    inventoryRecordID?: string;
    level?: PartyType;
    page?: number;
    pageSize?: number;
    userGroupID?: string;
    userID?: string;
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TInventoryRecordAssignment>>>
Get a list of inventory record assignments. Check out the docs for more info
Type Parameters
- TInventoryRecordAssignment extends InventoryRecordAssignment
Parameters
- productID: string
  
  ID of the product.
- listOptions: {
      buyerID?: string;
      inventoryRecordID?: string;
      level?: PartyType;
      page?: number;
      pageSize?: number;
      userGroupID?: string;
      userID?: string;
  } = {}
  - Optional buyerID?: string
    
    ID of the buyer.
  - Optional inventoryRecordID?: string
    
    ID of the inventory record.
  - Optional level?: PartyType
    
    Level of the inventory record assignment. Possible values: User, Group, Company.
  - 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 userGroupID?: string
    
    ID of the user group.
  - Optional userID?: string
    
    ID of the user.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TInventoryRecordAssignment>>>
- Defined in api/InventoryRecords.ts:222

ListVariant

ListVariant<TInventoryRecord>(productID: string, variantID: string, listOptions?: {
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: ("ID" | "AddressID")[];
    sortBy?: ("ID" | "AddressID" | "!ID" | "!AddressID")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TInventoryRecord>>>
Get a list of variant inventory records. Check out the docs for more info
Type Parameters
- TInventoryRecord extends InventoryRecord<any, any, TInventoryRecord>
Parameters
- productID: string
  
  ID of the product.
- variantID: string
  
  ID of the variant.
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "AddressID")[];
      sortBy?: ("ID" | "AddressID" | "!ID" | "!AddressID")[];
  } = {}
  - 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" | "AddressID")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ID" | "AddressID" | "!ID" | "!AddressID")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TInventoryRecord>>>
- Defined in api/InventoryRecords.ts:272

ListVariantAssignments

ListVariantAssignments<TInventoryRecordAssignment>(productID: string, variantID: string, listOptions?: {
    buyerID?: string;
    inventoryRecordID?: string;
    level?: PartyType;
    page?: number;
    pageSize?: number;
    userGroupID?: string;
    userID?: string;
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TInventoryRecordAssignment>>>
Get a list of inventory record variant assignments. Check out the docs for more info
Type Parameters
- TInventoryRecordAssignment extends InventoryRecordAssignment
Parameters
- productID: string
  
  ID of the product.
- variantID: string
  
  ID of the variant.
- listOptions: {
      buyerID?: string;
      inventoryRecordID?: string;
      level?: PartyType;
      page?: number;
      pageSize?: number;
      userGroupID?: string;
      userID?: string;
  } = {}
  - Optional buyerID?: string
    
    ID of the buyer.
  - Optional inventoryRecordID?: string
    
    ID of the inventory record.
  - Optional level?: PartyType
    
    Level of the inventory record assignment. Possible values: User, Group, Company.
  - 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 userGroupID?: string
    
    ID of the user group.
  - Optional userID?: string
    
    ID of the user.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TInventoryRecordAssignment>>>
- Defined in api/InventoryRecords.ts:444

Patch

Patch<TInventoryRecord>(productID: string, inventoryRecordID: string, inventoryRecord: PartialObjectDeep<InventoryRecord<any, any>>, requestOptions?: RequestOptions): Promise<RequiredDeep<TInventoryRecord>>
Partially update an inventory record. Check out the docs for more info
Type Parameters
- TInventoryRecord extends InventoryRecord<any, any, TInventoryRecord>
Parameters
- productID: string
  
  ID of the product.
- inventoryRecordID: string
  
  ID of the inventory record.
- inventoryRecord: PartialObjectDeep<InventoryRecord<any, any>>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TInventoryRecord>>
- Defined in api/InventoryRecords.ts:169

PatchVariant

PatchVariant<TInventoryRecord>(productID: string, variantID: string, inventoryRecordID: string, inventoryRecord: PartialObjectDeep<InventoryRecord<any, any>>, requestOptions?: RequestOptions): Promise<RequiredDeep<TInventoryRecord>>
Partially update a variant inventory record. Check out the docs for more info
Type Parameters
- TInventoryRecord extends InventoryRecord<any, any, TInventoryRecord>
Parameters
- productID: string
  
  ID of the product.
- variantID: string
  
  ID of the variant.
- inventoryRecordID: string
  
  ID of the inventory record.
- inventoryRecord: PartialObjectDeep<InventoryRecord<any, any>>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TInventoryRecord>>
- Defined in api/InventoryRecords.ts:389

Save

Save<TInventoryRecord>(productID: string, inventoryRecordID: string, inventoryRecord: InventoryRecord<any, any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TInventoryRecord>>
Create or update an inventory record. If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TInventoryRecord extends InventoryRecord<any, any, TInventoryRecord>
Parameters
- productID: string
  
  ID of the product.
- inventoryRecordID: string
  
  ID of the inventory record.
- inventoryRecord: InventoryRecord<any, any>
  
  Required fields: AddressID
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TInventoryRecord>>
- Defined in api/InventoryRecords.ts:124

SaveAssignment

SaveAssignment(productID: string, inventoryRecordAssignment: InventoryRecordAssignment, requestOptions?: RequestOptions): Promise<void>
Create or update an inventory record assignment. Check out the docs for more info
Parameters
- productID: string
  
  ID of the product.
- inventoryRecordAssignment: InventoryRecordAssignment
  
  Required fields: InventoryRecordID, BuyerID
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/InventoryRecords.ts:244

SaveVariant

SaveVariant<TInventoryRecord>(productID: string, variantID: string, inventoryRecordID: string, inventoryRecord: InventoryRecord<any, any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TInventoryRecord>>
Create or update a variant inventory record. Check out the docs for more info
Type Parameters
- TInventoryRecord extends InventoryRecord<any, any, TInventoryRecord>
Parameters
- productID: string
  
  ID of the product.
- variantID: string
  
  ID of the variant.
- inventoryRecordID: string
  
  ID of the inventory record.
- inventoryRecord: InventoryRecord<any, any>
  
  Required fields: AddressID
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TInventoryRecord>>
- Defined in api/InventoryRecords.ts:342

SaveVariantAssignment

SaveVariantAssignment(productID: string, variantID: string, inventoryRecordAssignment: InventoryRecordAssignment, requestOptions?: RequestOptions): Promise<void>
Create or update an inventory record variant assignment. Check out the docs for more info
Parameters
- productID: string
  
  ID of the product.
- variantID: string
  
  ID of the variant.
- inventoryRecordAssignment: InventoryRecordAssignment
  
  Required fields: InventoryRecordID, BuyerID
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/InventoryRecords.ts:467

Class InventoryRecords

Hierarchy

Index

Properties

Methods

Properties

Private impersonating

Methods

As

Description

Example

Returns InventoryRecords

Create

Type Parameters

TInventoryRecord extends InventoryRecord<any, any, TInventoryRecord>

Parameters

productID: string

inventoryRecord: InventoryRecord<any, any>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TInventoryRecord>>

CreateVariant

Type Parameters

TInventoryRecord extends InventoryRecord<any, any, TInventoryRecord>

Parameters

productID: string

variantID: string

inventoryRecord: InventoryRecord<any, any>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TInventoryRecord>>

Delete

Parameters

productID: string

inventoryRecordID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

DeleteAssignment

Parameters

productID: string

inventoryRecordID: string

listOptions: { buyerID?: string; userGroupID?: string; userID?: string; } = {}

Optional buyerID?: string

Optional userGroupID?: string

Optional userID?: string

requestOptions: RequestOptions = {}

Returns Promise<void>

DeleteVariant

Parameters

productID: string

variantID: string

inventoryRecordID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

DeleteVariantAssignment

Parameters

productID: string

variantID: string

inventoryRecordID: string

listOptions: { buyerID?: string; userGroupID?: string; userID?: string; } = {}

Optional buyerID?: string

Optional userGroupID?: string

Optional userID?: string

requestOptions: RequestOptions = {}

Returns Promise<void>

Get

Type Parameters

TInventoryRecord extends InventoryRecord<any, any, TInventoryRecord>

Parameters

productID: string

inventoryRecordID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TInventoryRecord>>

GetVariant

Type Parameters

TInventoryRecord extends InventoryRecord<any, any, TInventoryRecord>

Parameters

productID: string

variantID: string

inventoryRecordID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TInventoryRecord>>

`Private` impersonating

listOptions: {
buyerID?: string;
userGroupID?: string;
userID?: string;
} = {}

`Optional` buyerID?: string

`Optional` userGroupID?: string

`Optional` userID?: string

listOptions: {
buyerID?: string;
userGroupID?: string;
userID?: string;
} = {}

`Optional` buyerID?: string

`Optional` userGroupID?: string

`Optional` userID?: string

listOptions: {
filters?: Filters;
page?: number;
pageSize?: number;
search?: string;
searchOn?: ("ID" | "AddressID")[];
sortBy?: ("ID" | "AddressID" | "!ID" | "!AddressID")[];
} = {}

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

`Optional` searchOn?: ("ID" | "AddressID")[]

`Optional` sortBy?: ("ID" | "AddressID" | "!ID" | "!AddressID")[]

listOptions: {
buyerID?: string;
inventoryRecordID?: string;
level?: PartyType;
page?: number;
pageSize?: number;
userGroupID?: string;
userID?: string;
} = {}

`Optional` buyerID?: string

`Optional` inventoryRecordID?: string

`Optional` level?: PartyType

`Optional` page?: number

`Optional` pageSize?: number

`Optional` userGroupID?: string

`Optional` userID?: string

listOptions: {
filters?: Filters;
page?: number;
pageSize?: number;
search?: string;
searchOn?: ("ID" | "AddressID")[];
sortBy?: ("ID" | "AddressID" | "!ID" | "!AddressID")[];
} = {}

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

`Optional` searchOn?: ("ID" | "AddressID")[]

`Optional` sortBy?: ("ID" | "AddressID" | "!ID" | "!AddressID")[]

listOptions: {
buyerID?: string;
inventoryRecordID?: string;
level?: PartyType;
page?: number;
pageSize?: number;
userGroupID?: string;
userID?: string;
} = {}

`Optional` buyerID?: string

`Optional` inventoryRecordID?: string

`Optional` level?: PartyType

`Optional` page?: number

`Optional` pageSize?: number

`Optional` userGroupID?: string

`Optional` userID?: string