commerce
item

Create an item

Changed on
post/commerce/{connection_id}/item

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/commerce/{connection_id}/item
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Request body

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring
public_namestring
slugstring
descriptionstring
global_codestring
public_descriptionstring
is_activeboolean
is_taxableboolean
vendor_namestring
typestring

product, service, digital-download, ...

is_visibleboolean
is_featuredboolean
weightnumber
weight_unit'g' | 'kg' | 'oz' | 'lb'
requires_shippingboolean
inventory_idstring
total_stocknumber
tagsstring[]
account_idstring

Reference to Accounting Account (reference to AccountingAccount)

taxrate_idstring

references AccountingTaxrate

location_idstring

(reference to CommerceLocation)

durationnumber

minutes

rawobject

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring
public_namestring
slugstring
descriptionstring
global_codestring
public_descriptionstring
is_activeboolean
is_taxableboolean
vendor_namestring
typestring

product, service, digital-download, ...

is_visibleboolean
is_featuredboolean
weightnumber
weight_unit'g' | 'kg' | 'oz' | 'lb'
requires_shippingboolean
inventory_idstring
total_stocknumber
tagsstring[]
account_idstring

Reference to Accounting Account (reference to AccountingAccount)

taxrate_idstring

references AccountingTaxrate

location_idstring

(reference to CommerceLocation)

durationnumber

minutes

rawobject

Changes

  • b837b009e30dRevision changes
    • breaking

      removed the enum value variants from the property items/ of the query request parameter fields

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

  • 3bea28547cc7Revision changes
    • breaking

      removed the enum value collection_ids from the property items/ of the query request parameter fields

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status