Create Product

POST 
/products/

Use this endpoint to create a single product. If a product is successfully created, the response will include the productid.

Fields

Name	Required
names	no
language	yes
parent	no
sku	no (recommended)
unit	no Default is 1
status	no Default is A
priceDisplay	no Default is default
descriptions	no
shortName	no
shortDescriptions	no
taxCode	no Default is H
supplier	no (recommended)
supplierCode	no (recommended)
manufacturer	no
oemCode	no
eanCode	no
minimumQuantity	no Default is 1
package	no
packageDescriptions	no
notes	no
sourceId	no
source	only when sourceId is provided
keywords	no
customKeywords	no
statusExtra	no
orderable	no
orderableFrom	no
orderableTo	no
releaseDate	no
returnable	no
physical	no
barCode	no
width	no
height	no
depth	no
weight	no
packageUnit	no
packageUnitQuantity	no
purchaseMinimumQuantity	no
purchaseUnit	no
economicOrderQuantity	no

Request

application/json

Body

descriptions

object[]

Array [

language string

value string

]

eanCode string
language string
manufacturer string
minimumQuantity number

names

object[]

Array [

language string

value string

]

notes

object[]

Array [

language string

value string

]

oemCode string
package string

packageDescriptions

object[]

Array [

language string

value string

]

parent

object

id number

shortDescriptions

object[]

Array [

language string

value string

]

shortName string
sku string
source string
sourceId string
status string
supplier string
supplierCode string
taxCode string
unit number

Responses

201

Create Product - 200

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• server

  string

• x-request-id

  string

application/json

Schema

Schema

data

object

descriptions

object[]

Array [

language string

value string

]

eanCode string

id number

language string

manufacturer string

minimumQuantity number

names

object[]

Array [

language string

value string

]

notes

object[]

Array [

language string

value string

]

oemCode string

package string

packageDescriptions

object[]

Array [

language string

value string

]

parent

object

id number

shortDescriptions

object[]

Array [

language string

value string

]

shortName string

sku string

source string

sourceId string

status string

supplier string

supplierCode string

taxCode string

unit number
messages string[]
total number

Example (from schema)

{
  "data": {
    "descriptions": [
      {
        "language": "NL",
        "value": "De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."
      },
      {
        "language": "EN",
        "value": "The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."
      }
    ],
    "eanCode": "0753759256289",
    "id": 40360,
    "language": "NL",
    "manufacturer": "Garmin",
    "minimumQuantity": 1,
    "names": [
      {
        "language": "NL",
        "value": "Edge 1030 FietsComputer"
      },
      {
        "language": "EN",
        "value": "Edge 1030 Bike computer"
      }
    ],
    "notes": [
      {
        "language": "NL",
        "value": "Edge 1030 FietsComputer"
      },
      {
        "language": "EN",
        "value": "Edge 1030 Bike computer"
      }
    ],
    "oemCode": "NCABD70004",
    "package": "STK",
    "packageDescriptions": [
      {
        "language": "NL",
        "value": "Stuks"
      },
      {
        "language": "EN",
        "value": "Pieces"
      }
    ],
    "parent": {
      "id": 1771
    },
    "shortDescriptions": [
      {
        "language": "NL",
        "value": "De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."
      },
      {
        "language": "EN",
        "value": "The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."
      }
    ],
    "shortName": "Edge 1030 FietsComputer",
    "sku": "NCABD70004",
    "source": "TECHDATA",
    "sourceId": "NCABD70004",
    "status": "A",
    "supplier": "TECHDATA",
    "supplierCode": "NCABD70004",
    "taxCode": "H",
    "unit": 1
  },
  "messages": [
    "Product created"
  ],
  "total": 1
}

Create Product - 200

{
  "data": {
    "descriptions": [
      {
        "language": "NL",
        "value": "De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen.<br />De Garmin Edge 1030 is uitgerust met Popularity Routing, dat de beste routes vindt, gebaseerd op miljoenen afgelegde fietskilometers in Garmin Connect. Bovendien kun je snel berichten sturen naar je fietsvrienden met rider-to-rider messaging. Je kunt bovendien live je prestaties analyseren dankzij de verbeterde realtime Strava integratie en de voorgeïnstalleerde TrainingPeaks Connect IQ app. Dit geeft je net dat duwtje in de rug om je persoonlijke records (of die van je vrienden) te verbrijzelen."
      },
      {
        "language": "EN",
        "value": "The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing.<br />Garmin Edge 1030 features Popularity Routing, which finds the best routes based on millions of bike miles traveled in Garmin Connect. Plus, you can quickly message your cycling friends with rider-to-rider messaging. You can also analyze your performance live thanks to the improved real-time Strava integration and the pre-installed TrainingPeaks Connect IQ app. This gives you just that little push to shatter your personal bests (or those of your friends)."
      }
    ],
    "eanCode": "0753759256289",
    "id": 40360,
    "language": "NL",
    "manufacturer": "Garmin",
    "minimumQuantity": 1,
    "names": [
      {
        "language": "NL",
        "value": "Edge 1030 FietsComputer"
      },
      {
        "language": "EN",
        "value": "Edge 1030 Bike computer"
      }
    ],
    "notes": [
      {
        "language": "NL",
        "value": "Edge 1030 FietsComputer"
      },
      {
        "language": "EN",
        "value": "Edge 1030 Bike computer"
      }
    ],
    "oemCode": "NCABD70004",
    "package": "STK",
    "packageDescriptions": [
      {
        "language": "NL",
        "value": "Stuks"
      },
      {
        "language": "EN",
        "value": "Pieces"
      }
    ],
    "parent": {
      "id": 1771
    },
    "shortDescriptions": [
      {
        "language": "NL",
        "value": "De high-end Edge 1030 fietscomputer van Garmin zit boordevol functies voor geweldige fietsavonturen. Met deze fietscomputer weet je niet alleen waar je bent en waar je naartoe moet, je weet ook welke routes populair zijn en wat je fietsmaten doen."
      },
      {
        "language": "EN",
        "value": "The high-end Garmin Edge 1030 bike computer is packed with features for great cycling adventures. With this cycling computer you not only know where you are and where you have to go, you also know which routes are popular and what your bike sizes are doing."
      }
    ],
    "shortName": "Edge 1030 FietsComputer",
    "sku": "NCABD70004",
    "source": "TECHDATA",
    "sourceId": "NCABD70004",
    "status": "A",
    "supplier": "TECHDATA",
    "supplierCode": "NCABD70004",
    "taxCode": "H",
    "unit": 1
  },
  "messages": [
    "Product created"
  ],
  "total": 1
}

400

Create Product - 400 (existing sourceId)

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• server

  string

• x-request-id

  string

application/json

Schema

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "error": {
    "code": 80004,
    "messages": [
      "Product with sourceId [NCABD70004] already exists"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/80004",
    "status": 400,
    "type": "ProductExists"
  }
}

Create Product - 400 (existing sourceId)

{
  "error": {
    "code": 80004,
    "messages": [
      "Product with sourceId [NCABD70004] already exists"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/80004",
    "status": 400,
    "type": "ProductExists"
  }
}

Loading...