POST Catalog/AddProduct

Only for admin Role

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
ExternalID	ID of Variation in the external database (Use only for data sync)	string	None.
ProviderID		integer	None.
Reference		string	Required
Name		string	Required
ShortDescription		string	None.
Description		string	None.
TitleTag	Seo Title Tag	string	String length: inclusive between 0 and 100
MetaDescription	Seo MetaDescription	string	String length: inclusive between 0 and 400
TaxRateID		integer	None.
BrandID		integer	None.
CollectionID		integer	None.
ShippingTime	Days needed to ship this product	decimal number	None.
PublishFrom	publication from date	date	Required
PublishTill	publication till date	date	None.
Disabled	Unpublished product	date	None.
Discontinued		date	None.
NotSell	This product is not for sell	boolean	None.
SalesStockPolicyID	Generic SalesStockPolicy for this product	integer	None.
Weight		decimal number	None.
Dimensions		Dimensions	None.
MinimumOrderQuantity	Minimum quantity that must be placed in each order; 0 = 1	decimal number	None.
MaximumOrderQuantity	Maximum quantity that can be placed in each order; 0 = no limit	decimal number	None.
OrderQuantityStep	Sets the number of items that have to be grouped together to place an Order	decimal number	None.
ConditionID		integer	None.
Lang		string	None.
StoreID		integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ExternalID": "sample string 1",
  "ProviderID": 2,
  "Reference": "sample string 3",
  "Name": "sample string 4",
  "ShortDescription": "sample string 5",
  "Description": "sample string 6",
  "TitleTag": "sample string 7",
  "MetaDescription": "sample string 8",
  "TaxRateID": 9,
  "BrandID": 1,
  "CollectionID": 1,
  "ShippingTime": 10.0,
  "PublishFrom": "2025-12-06T09:18:04.7506387+01:00",
  "PublishTill": "2025-12-06T09:18:04.7506387+01:00",
  "Disabled": "2025-12-06T09:18:04.7506387+01:00",
  "Discontinued": "2025-12-06T09:18:04.7506387+01:00",
  "NotSell": true,
  "SalesStockPolicyID": 13,
  "Weight": 14.0,
  "Dimensions": {
    "Width": 1.0,
    "Height": 2.0,
    "Depth": 3.0
  },
  "MinimumOrderQuantity": 15.0,
  "MaximumOrderQuantity": 16.0,
  "OrderQuantityStep": 17.0,
  "ConditionID": 1,
  "Lang": "sample string 18",
  "StoreID": 19
}

application/xml, text/xml

Sample:

<AddProductBinding xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Binding.Catalog">
  <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">sample string 18</Lang>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">19</StoreID>
  <BrandID>1</BrandID>
  <CollectionID>1</CollectionID>
  <ConditionID>1</ConditionID>
  <Description>sample string 6</Description>
  <Dimensions xmlns:d2p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Core.Models.Base">
    <d2p1:Depth>3</d2p1:Depth>
    <d2p1:Height>2</d2p1:Height>
    <d2p1:Width>1</d2p1:Width>
  </Dimensions>
  <Disabled>2025-12-06T09:18:04.7506387+01:00</Disabled>
  <Discontinued>2025-12-06T09:18:04.7506387+01:00</Discontinued>
  <ExternalID>sample string 1</ExternalID>
  <MaximumOrderQuantity>16</MaximumOrderQuantity>
  <MetaDescription>sample string 8</MetaDescription>
  <MinimumOrderQuantity>15</MinimumOrderQuantity>
  <Name>sample string 4</Name>
  <NotSell>true</NotSell>
  <OrderQuantityStep>17</OrderQuantityStep>
  <ProviderID>2</ProviderID>
  <PublishFrom>2025-12-06T09:18:04.7506387+01:00</PublishFrom>
  <PublishTill>2025-12-06T09:18:04.7506387+01:00</PublishTill>
  <Reference>sample string 3</Reference>
  <SalesStockPolicyID>13</SalesStockPolicyID>
  <ShippingTime>10</ShippingTime>
  <ShortDescription>sample string 5</ShortDescription>
  <TaxRateID>9</TaxRateID>
  <TitleTag>sample string 7</TitleTag>
  <Weight>14</Weight>
</AddProductBinding>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Product ID

integer

Response Formats

application/json, text/json

Sample:

application/xml, text/xml

Sample:

<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>