v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB
Product

Creates a Product resource.

Creates a Product resource.

post/products

Request body

idstring
integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

additionalTypestring nullable

An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.

alternateNamestring nullable

an alias for the item

awardstring nullable

an award won by or for this item

categoriesstring[] nullable

A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.

colorstring nullable

the color of the product

descriptionstring nullable

a description of the item

disambiguatingDescriptionstring nullable

A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.

gtin12string nullable

The [GTIN-12](http://apps.gs1.org/GDD/glossary/Pages/GTIN-12.aspx) code of the product, or the product to which the offer refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference, and Check Digit used to identify trade items. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.

gtin13sstring[] nullable

The [GTIN-13](http://apps.gs1.org/GDD/glossary/Pages/GTIN-13.aspx) code of the product, or the product to which the offer refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into a GTIN-13 code by simply adding a preceeding zero. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.

gtin14sstring[] nullable

The [GTIN-14](http://apps.gs1.org/GDD/glossary/Pages/GTIN-14.aspx) code of the product, or the product to which the offer refers. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.

gtin8sstring[] nullable

The [GTIN-8](http://apps.gs1.org/GDD/glossary/Pages/GTIN-8.aspx) code of the product, or the product to which the offer refers. This code is also known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.

imagestring nullable

An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].

isAccessoryOrSparePartForsstring[] nullable

a pointer to another product (or multiple products) for which this product is an accessory or spare part

isConsumableForsstring[] nullable

a pointer to another product (or multiple products) for which this product is a consumable

isRelatedTostring iri-reference nullable

a pointer to another, somehow related product (or multiple products)

isSimilarTosstring[] nullable

a pointer to another, functionally similar product (or multiple products)

itemConditionstring nullable

a predefined value from OfferItemCondition or a textual description of the condition of the product or service, or the products or services included in the offer

modelstring nullable

The model of the product. Use with the URL of a ProductModel or a textual representation of the model identifier. The URL of the ProductModel can be from an external source. It is recommended to additionally provide strong product identifiers via the gtin8/gtin13/gtin14 and mpn properties.

mpnsstring[] nullable

the Manufacturer Part Number (MPN) of the product, or the product to which the offer refers

manufacturerstring nullable

the manufacturer of the product

namestring nullable

the name of the item

productIDstring nullable

The product identifier, such as ISBN. For example: meta itemprop="productID" content="isbn:123-456-789".

releaseDatestring date-time nullable

The release date of a product or product model. This can be used to distinguish the exact variant of a product.

sameAstring nullable

URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.

skusstring[] nullable

The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers.

urlstring nullable

URL of the item

materialstring nullable

A material that something is made from, e.g. leather, wool, cotton, paper.

productionDatestring date-time nullable

The date of production of the item, e.g. vehicle.

purchaseDatestring date-time nullable

The date the item e.g. vehicle was purchased by the current owner.

identifierstring nullable

The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.

srcIdstring

Unique identifier for a product

isActivestring nullable

Whether the product is active or not

heightinteger nullable

The height of the product

widthinteger nullable

Width of the product

weightinteger nullable

Weight of the product

quantityinteger nullable

Quantity of product available

availableForPurchaseboolean nullable

Whether the product is available for purchase or not

updatedstring nullable

The date and time the product was last modified

priceinteger nullable

The price of the product

weightUnitstring nullable

The unit weight is measured in

heightUnitstring nullable

The unit height is measured in

widthUnitstring nullable

The unit width is measured in

Example request

{
  "integration": "quickbooks"
}

Response

Product resource created

idstring
integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

additionalTypestring nullable

An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.

alternateNamestring nullable

an alias for the item

awardstring nullable

an award won by or for this item

categoriesstring[] nullable

A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.

colorstring nullable

the color of the product

descriptionstring nullable

a description of the item

disambiguatingDescriptionstring nullable

A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.

gtin12string nullable

The [GTIN-12](http://apps.gs1.org/GDD/glossary/Pages/GTIN-12.aspx) code of the product, or the product to which the offer refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference, and Check Digit used to identify trade items. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.

gtin13sstring[] nullable

The [GTIN-13](http://apps.gs1.org/GDD/glossary/Pages/GTIN-13.aspx) code of the product, or the product to which the offer refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into a GTIN-13 code by simply adding a preceeding zero. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.

gtin14sstring[] nullable

The [GTIN-14](http://apps.gs1.org/GDD/glossary/Pages/GTIN-14.aspx) code of the product, or the product to which the offer refers. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.

gtin8sstring[] nullable

The [GTIN-8](http://apps.gs1.org/GDD/glossary/Pages/GTIN-8.aspx) code of the product, or the product to which the offer refers. This code is also known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.

imagestring nullable

An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].

isAccessoryOrSparePartForsstring[] nullable

a pointer to another product (or multiple products) for which this product is an accessory or spare part

isConsumableForsstring[] nullable

a pointer to another product (or multiple products) for which this product is a consumable

isRelatedTostring iri-reference nullable

a pointer to another, somehow related product (or multiple products)

isSimilarTosstring[] nullable

a pointer to another, functionally similar product (or multiple products)

itemConditionstring nullable

a predefined value from OfferItemCondition or a textual description of the condition of the product or service, or the products or services included in the offer

modelstring nullable

The model of the product. Use with the URL of a ProductModel or a textual representation of the model identifier. The URL of the ProductModel can be from an external source. It is recommended to additionally provide strong product identifiers via the gtin8/gtin13/gtin14 and mpn properties.

mpnsstring[] nullable

the Manufacturer Part Number (MPN) of the product, or the product to which the offer refers

manufacturerstring nullable

the manufacturer of the product

namestring nullable

the name of the item

productIDstring nullable

The product identifier, such as ISBN. For example: meta itemprop="productID" content="isbn:123-456-789".

releaseDatestring date-time nullable

The release date of a product or product model. This can be used to distinguish the exact variant of a product.

sameAstring nullable

URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.

skusstring[] nullable

The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers.

urlstring nullable

URL of the item

materialstring nullable

A material that something is made from, e.g. leather, wool, cotton, paper.

productionDatestring date-time nullable

The date of production of the item, e.g. vehicle.

purchaseDatestring date-time nullable

The date the item e.g. vehicle was purchased by the current owner.

identifierstring nullable

The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.

srcIdstring

Unique identifier for a product

isActivestring nullable

Whether the product is active or not

heightinteger nullable

The height of the product

widthinteger nullable

Width of the product

weightinteger nullable

Weight of the product

quantityinteger nullable

Quantity of product available

availableForPurchaseboolean nullable

Whether the product is available for purchase or not

updatedstring nullable

The date and time the product was last modified

priceinteger nullable

The price of the product

weightUnitstring nullable

The unit weight is measured in

heightUnitstring nullable

The unit height is measured in

widthUnitstring nullable

The unit width is measured in

Example response

{
  "integration": "quickbooks"
}