Basic information
POST /{shopId}/products
Creates a new product.
Authorisation
OAuth 2.0 Token required with scopes:
products_write
URI parameters
| Name | Type | Description |
|---|---|---|
shopId |
string |
The unique identifier of the shop. Required:
true
Example:
DemoShop
|
Query parameters
| Name | Type | Description |
|---|---|---|
locale |
string |
Represents the language code according to ISO 639-1 and the country code according to ISO 3166-1. If not provided, the shop’s default language is used. We recommend to always send this parameter with your request. If the default language had been changed in the administration, it might take up to 1 day until this change affects the shop. Required:
false
Example:
en_US
|
currency |
string |
Represents the currency code according to ISO 4217. Required:
false
Example:
EUR
|
Request attributes
| Name | Type | Description |
|---|---|---|
|
object of product (create request) |
Request body
Media type application/json
{
"productNumber": "TP-0815",
"name": "Brand new product",
"shortDescription": "Awesome product",
"description": "This is a brand new product",
"manufacturer": "Awesome Products Company",
"price": 5.99,
"searchKeywords": ["awesome", "product"]
}
Response attributes
| Name | Type | Description |
|---|---|---|
|
object of product |
Response
HTTP 201
Media type application/json
{
"productId": "57D647C1-77D5-DD52-3024-D5809AB3A134",
"name": "Amazing Gracephones",
"visible": false,
"productVariationType": "regular",
"productVariationMasterName": null,
"productVariationMasterId": null,
"manufacturerProductNumber": null,
"productLength": null,
"productWidth": null,
"productHeight": null,
"productVariationSelection": null,
"shortDescription": "Awesome new product",
"deliveryPeriod": null,
"description": "This is a brand new product",
"title": "Amazing Gracephones - Technic365",
"productImage": null,
"images": [],
"priceInfo": {
"quantity": {
"amount": 1,
"unit": "piece(s)"
},
"taxClass": {
"taxClassId": "5446685F-A8AF-0E18-9B4F-D5809AB30FBF",
"name": "standard",
"percentage": 19
},
"price": {
"taxType": "NET",
"formatted": "10.99 €",
"amount": 10.99,
"currency": "EUR"
},
"depositPrice": null,
"ecoParticipationPrice": null,
"priceWithDeposits": {
"taxType": "NET",
"formatted": "10.99 €",
"amount": 10.99,
"currency": "EUR"
},
"lowestPrice": null,
"lowestRefPriceFormatted": null,
"highestPrice": null,
"manufacturerPrice": null,
"basePrice": null
},
"forSale": false,
"specialOffer": false,
"deliveryWeight": null,
"availabilityText": "",
"availability": null,
"energyLabelsString": "A+++",
"energyLabelsMaxEfficiencyString": "A+++",
"energyLabelSourceFile": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/Products/be_40401/label-1-9dee74f24e1.png",
"productDataSheet": null,
"sfUrl": "http://pm.epages.com/epages/apidocu.sf/?ObjectPath=/Shops/apidocu/Products/TP-0821",
"productNumber": "TP-0821",
"isProductNumberVisible": true,
"isNew": false,
"isManufacturerPriceRRP": true,
"isShippingLinkVisible": true,
"isCustomizable": true,
"customizableTextLength": 50,
"customizableHeadlineText": "Customize your product",
"newnessDate": "2023-08-08T00:00:00Z",
"refAmount": 1,
"refUnit": "piece",
"refContentAmount": 1,
"priceQuantity": 1,
"orderUnit": "piece(s)",
"minOrder": 1,
"intervalOrder": 1,
"productCode": null,
"manufacturer": "Awesome Products Company",
"upc": null,
"ean": null,
"essentialFeatures": null,
"searchKeywords": [
"awesome",
"product"
],
"stocklevel": null,
"minStocklevel": null,
"isInWishlist": false,
"videos": [],
"links": [
{
"rel": "self",
"href": "https://pm.epages.com/rs/shops/apidocu/products/57D647C1-77D5-DD52-3024-D5809AB3A134"
},
{
"rel": "categories",
"href": "https://pm.epages.com/rs/shops/apidocu/categories/?productId=57D647C1-77D5-DD52-3024-D5809AB3A134"
},
{
"rel": "producttype",
"href": "https://pm.epages.com/rs/shops/apidocu/producttypes/6489A241-7B85-54B0-0B69-C0A8020205ED"
}
]
}