Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Applicable only when the action value is EXTERNAL.

 Inventory items

List of inventory items. Represents the goods available to be shipped to a customer. It holds essential information about the goods, including SKU and whether it is tracked.

Field

Description

Country code of origin

The ISO code of the country of origin.

Created at

The date and time when the inventory item was created.

Harmonized system code

The harmonized system code of the item.

ID

Globally unique ID.

Inventory history URL

URL for inventory history web page.

Legacy resource ID

The ID of the corresponding resource in the REST Admin API.

Locations count

The number of locations where this inventory item is stocked.

Province code of origin

The ISO code of the province of origin.

Requires shipping

Whether the item requires shipping or not.

SKU

Inventory item SKU.

Tracked

Whether the inventory quantities of inventory levels for the item are tracked or not.

Updated at

The date and time when the inventory item was updated.

Variant ID

The ID of the variant that owns this inventory item.

 Inventory items / Country harmonized system codes

A list of country specific harmonized system codes.

Field

Description

Country code

Country ISO code.

Harmonized system code

Country specific harmonized system code.

 Inventory items / Inventory levels

A list of the inventory item's quantities for each location that the inventory item can be stocked at.

Field

Description

Available

Quantity of items available at the location.

Created at

The date and time when the inventory level was created.

Deactivation alert

Reason why canDeactivate is false, or impact of deactivating the inventory level.

Deactivation alert HTML

Reason why canDeactivate is false with URLs linked in HTML, or impact of deactivating the inventory level.

Incoming

Quantity of items incoming to the location.

Updated at

The date and time when the inventory level was updated.

 Inventory items / Inventory levels / Location

Location associated with the inventory level.

Filed

Description

Activatable

Whether this location can be reactivated.

Address verified

Whether the location address has been verified.

Deactivatable

Whether this location can be deactivated.

Deactivated at

Date and time the location was deactivated (null if location is still active).

Deletable

Whether this location can be deleted.

Fulfills online orders

Indicates whether this location can fulfill online orders.

Has active inventory

Indicates whether or not this location has active inventory.

Has unfulfilled orders

Indicates whether or not this location has unfulfilled orders.

ID

Globally unique ID.

Is active

Whether the location is active.

Legacy resource ID

The ID of the corresponding resource in the REST Admin API.

Name

The name of the location.

Ships inventory

Indicates whether or not this location is used for calculating shipping rates.

 Inventory items / Inventory levels / Quantities

Quantities for the requested names.

Field

Description

Name

The name that identifies the inventory quantity.

Quantity

The quantity for the quantity name.

Updated at

When the quantity was last updated.

 Inventory items / Tracked editable

Whether changes to the fulfillment service for the product variant are allowed.

Field

Description

Locked

Whether the attribute is locked for editing.

Reason

The reason the attribute is locked for editing.

 Inventory items / Unit cost

Unit cost associated with the inventory item.

Field

Description

Amount

Money amount.

Currency code

Currency of the money.

  • No labels