POST Catalog/Variations

Get Variations from a Product

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ID	integer	None.
Reference	string	None.
Lang	string	None.
StoreID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "Reference": "sample string 1",
  "Lang": "sample string 2",
  "StoreID": 3
}

application/xml, text/xml

Sample:

<GetProductRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Catalog">
  <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">sample string 2</Lang>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">3</StoreID>
  <ID>1</ID>
  <Reference>sample string 1</Reference>
</GetProductRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of Variation

Name	Description	Type	Additional information
ID		integer	None.
Created		date	None.
Modified		date	None.
ExternalID	ID of Variation in the external database (Use only for data sync)	string	None.
Disabled		date	None.
PublishFrom	publication from date	date	None.
PublishTill	publication till date	date	None.
ProductID		integer	None.
ShortDescription		string	None.
Description		string	None.
SKU		string	Required String length: inclusive between 0 and 50
Quantity	Total quantity of this variation in all warehouses	decimal number	None.
ShippingTime		decimal number	None.
SortOrder		integer	None.
Attributes		Collection of ItemAttribute	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ID": 1,
    "Created": "2025-12-06T05:40:40.3889681+01:00",
    "Modified": "2025-12-06T05:40:40.3889681+01:00",
    "ExternalID": "sample string 4",
    "Disabled": "2025-12-06T05:40:40.3889681+01:00",
    "PublishFrom": "2025-12-06T05:40:40.3889681+01:00",
    "PublishTill": "2025-12-06T05:40:40.3889681+01:00",
    "ProductID": 6,
    "ShortDescription": "sample string 7",
    "Description": "sample string 8",
    "SKU": "sample string 9",
    "Quantity": 10.0,
    "ShippingTime": 1.0,
    "SortOrder": 11,
    "Attributes": [
      {
        "AttributeID": 1,
        "SortOrder": 2
      },
      {
        "AttributeID": 1,
        "SortOrder": 2
      }
    ]
  },
  {
    "ID": 1,
    "Created": "2025-12-06T05:40:40.3889681+01:00",
    "Modified": "2025-12-06T05:40:40.3889681+01:00",
    "ExternalID": "sample string 4",
    "Disabled": "2025-12-06T05:40:40.3889681+01:00",
    "PublishFrom": "2025-12-06T05:40:40.3889681+01:00",
    "PublishTill": "2025-12-06T05:40:40.3889681+01:00",
    "ProductID": 6,
    "ShortDescription": "sample string 7",
    "Description": "sample string 8",
    "SKU": "sample string 9",
    "Quantity": 10.0,
    "ShippingTime": 1.0,
    "SortOrder": 11,
    "Attributes": [
      {
        "AttributeID": 1,
        "SortOrder": 2
      },
      {
        "AttributeID": 1,
        "SortOrder": 2
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfVariation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Catalog">
  <Variation>
    <Attributes>
      <ItemAttribute>
        <AttributeID>1</AttributeID>
        <SortOrder>2</SortOrder>
      </ItemAttribute>
      <ItemAttribute>
        <AttributeID>1</AttributeID>
        <SortOrder>2</SortOrder>
      </ItemAttribute>
    </Attributes>
    <Created>2025-12-06T05:40:40.3889681+01:00</Created>
    <Description>sample string 8</Description>
    <Disabled>2025-12-06T05:40:40.3889681+01:00</Disabled>
    <ExternalID>sample string 4</ExternalID>
    <ID>1</ID>
    <Modified>2025-12-06T05:40:40.3889681+01:00</Modified>
    <ProductID>6</ProductID>
    <PublishFrom>2025-12-06T05:40:40.3889681+01:00</PublishFrom>
    <PublishTill>2025-12-06T05:40:40.3889681+01:00</PublishTill>
    <Quantity>10</Quantity>
    <SKU>sample string 9</SKU>
    <ShippingTime>1</ShippingTime>
    <ShortDescription>sample string 7</ShortDescription>
    <SortOrder>11</SortOrder>
  </Variation>
  <Variation>
    <Attributes>
      <ItemAttribute>
        <AttributeID>1</AttributeID>
        <SortOrder>2</SortOrder>
      </ItemAttribute>
      <ItemAttribute>
        <AttributeID>1</AttributeID>
        <SortOrder>2</SortOrder>
      </ItemAttribute>
    </Attributes>
    <Created>2025-12-06T05:40:40.3889681+01:00</Created>
    <Description>sample string 8</Description>
    <Disabled>2025-12-06T05:40:40.3889681+01:00</Disabled>
    <ExternalID>sample string 4</ExternalID>
    <ID>1</ID>
    <Modified>2025-12-06T05:40:40.3889681+01:00</Modified>
    <ProductID>6</ProductID>
    <PublishFrom>2025-12-06T05:40:40.3889681+01:00</PublishFrom>
    <PublishTill>2025-12-06T05:40:40.3889681+01:00</PublishTill>
    <Quantity>10</Quantity>
    <SKU>sample string 9</SKU>
    <ShippingTime>1</ShippingTime>
    <ShortDescription>sample string 7</ShortDescription>
    <SortOrder>11</SortOrder>
  </Variation>
</ArrayOfVariation>