Create inventory

POST

/{owner}/v1/inventory

Parameters

Path Parameters

owner

required

string

version

required

string

Request Body ^required

object

consumerReference

Any of:

string

string

null

null

title

required

Name of inventory item

string

defaultCountryOfOrigin

Any of:

string

string

null

null

harmonizedSystemCode

Any of:

string

string

>= 12 characters <= 12 characters

null

null

hazmatCode

Any of:

string

string

null

null

barcodes

required

The barcodes that can be physically attached to the item

Array<object>

object

type

required

string

barcode

required

string

dimensions

required

The dimensions of the item in supply chain. i.e. Boxed dimensions

object

height

required

Any of:

number

number

string

string

width

required

Any of:

number

number

string

string

depth

required

Any of:

number

number

string

string

mass

required

Any of:

number

number

string

string

batchControlled

required

Boolean Flag to denote if a product is batch controlled or not

boolean

description

required

A textual description of the inventory item

string

type

required

The type or category of the inventory item

string

Responses

200

object

meta

A meta object that contains non-standard meta-information

object

data

The document’s ‘primary data’.

object

id

required

Unique ID of the Entity

string

type

required

Type of entity

string

version

Any of:

string

string

null

null

attributes

This contains a data blob of the entity, this is where the main payload of data is

object

consumerReference

Any of:

string

string

null

null

title

required

Name of inventory item

string

defaultCountryOfOrigin

Any of:

string

string

null

null

harmonizedSystemCode

Any of:

string

string

>= 12 characters <= 12 characters

null

null

hazmatCode

Any of:

string

string

null

null

barcodes

required

The barcodes that can be physically attached to the item

Array<object>

object

type

required

string

barcode

required

string

dimensions

required

The dimensions of the item in supply chain. i.e. Boxed dimensions

object

height

required

Any of:

number

number

string

string

width

required

Any of:

number

number

string

string

depth

required

Any of:

number

number

string

string

mass

required

Any of:

number

number

string

string

batchControlled

required

Boolean Flag to denote if a product is batch controlled or not

boolean

description

required

A textual description of the inventory item

string

type

required

The type or category of the inventory item

string

links

Links to any relevant information or entities

object

self

required

Link to the current resource.

string

related

Link of a related resource.

string

describedBy

Link to API documentation for that resource.

string

meta

Additional information about the entity which isn’t provided in the main data blob

object

links

A links object related to the primary data

object

self

required

Link to the current resource.

string

related

Link of a related resource.

string

describedBy

Link to API documentation for that resource.

string

400

Bad request. Data not valid

object

meta

A meta object that contains non-standard meta-information

object

errors

An array of error objects

Array<object>

object

id

A unique identifier for this particular occurrence of the problem

string

links

Links explaining the error

object

about

A link that leads to further details about this particular occurrence of the problem.

string

type

A link that identifies the type of error that this particular error is an instance of.

string

status

The HTTP status code applicable to this problem

string

code

An application-specific error code

string

title

A summary of the problem

string

detail

Explanation specific to this occurrence of the problem

string

source

References to the primary source of the error

object

pointer

Any of:

string

string

null

null

parameter

Any of:

string

string

null

null

header

Any of:

string

string

null

null

meta

A meta object that contains non-standard meta-information

object

401

Unauthorized access, credentials are invalid.

403

Forbidden access, this is returned when you do not have sufficient permissions to access the resource

404

Not found

413

Payload exceeds maximum payload size of 256 kilobytes.

415

Media type is unsupported. All APIs, unless specified otherwise, only support JSON payloads.

422

Unprocessable entity

object

meta

A meta object that contains non-standard meta-information

object

errors

An array of error objects

Array<object>

object

id

A unique identifier for this particular occurrence of the problem

string

links

Links explaining the error

object

about

A link that leads to further details about this particular occurrence of the problem.

string

type

A link that identifies the type of error that this particular error is an instance of.

string

status

The HTTP status code applicable to this problem

string

code

An application-specific error code

string

title

A summary of the problem

string

detail

Explanation specific to this occurrence of the problem

string

source

References to the primary source of the error

object

pointer

Any of:

string

string

null

null

parameter

Any of:

string

string

null

null

header

Any of:

string

string

null

null

meta

A meta object that contains non-standard meta-information

object

429

Rate limit exceeded; once an API quota is reached a 429 is returned, wait 60 seconds and try again.

500

Unexpected internal error, could not process request

object

meta

A meta object that contains non-standard meta-information

object

errors

An array of error objects

Array<object>

object

id

A unique identifier for this particular occurrence of the problem

string

links

Links explaining the error

object

about

A link that leads to further details about this particular occurrence of the problem.

string

type

A link that identifies the type of error that this particular error is an instance of.

string

status

The HTTP status code applicable to this problem

string

code

An application-specific error code

string

title

A summary of the problem

string

detail

Explanation specific to this occurrence of the problem

string

source

References to the primary source of the error

object

pointer

Any of:

string

string

null

null

parameter

Any of:

string

string

null

null

header

Any of:

string

string

null

null

meta

A meta object that contains non-standard meta-information

object

503

The API is currently unavailable, please try again later

504

A request timed out while processing, please try again; if it persists try reducing the payload size.