Endpoint is used when customer selects a list of items to be created or updated.

Request

Post

`ProductsListingsRequest`

Field Name	Type	Description
AuthorizationToken	`String`	Authorization Token from the customers integration.
Type	`ListingUpdateType`	Determines if the relevant products need creating or updating on the channel. See ListingUpdateType
Listings	`ProductListing[]`	Array of listings for which the above action to be performed. See ProductListing
Settings	`ConfiguratorGeneralSetting[]`	The filled out customer settings that were provided in ConfiguratorSettings response by the developer. See ConfiguratorGeneralSetting

`ListingUpdateType (Flagged Enum)`

Field Name	Numeric Value	Description
CREATE	`0`	Create listing
UPDATE	`1`	Update Listing

`ProductListing`

Field Name	Type	Description
ConfiguratorId	`Integer`	Is used to lookup settings, if required.
TemplateId	`Integer`	Linnworks unique reference.
ExternalListingId	`Integer`	Unique listingid.
SKU	`String`	Channel SKU.
Title	`String`	Listing title.
Description	`String`	Listing description.
Quantity	`Integer`	Available quantity to sell.
Images	`ProductImage[]`	List of images for the non variation item along with the selected tags/ list of images for the variation parent item along with the selected tags. See ProductImage table.
Price	`Decimal`	Listing price.
Categories	`String[]`	Selected categories.
ShippingMethods	`ProductShipping[]`	Selected shipping. See ProductShipping table
Attributes	`ListingAttribute[]`	Attributes associated with non variation/variation parent item. See ListingAttribute table.
Variations	`ProductVariation[]`	List of variation items (will be empty for non variation items). See ProductVariationTable.
VariationOptions	`ProductOption[]`	List of variation options. See ProductOption table.

`ProductImage`

Field Name	Type	Description
Url	`String`	Url to an image.
Tags	`String[]`	Selected tags for the image (e.g "Basket image", "Large image" etc)

`ProductShipping`

Field Name	Type	Description
Price	`Decimal`	Shipping price for the shipping method.
ShippingMethodID	`String`	Shipping method id/tag.

`ListingAttribute`

Field Name	Type	Description
IsCustomAttribute	`Boolean`	Will be false, unless attribute was created by the customer.
AttributeID	`String`	Will not be set if it is a custom attribute created by the customer (only available if IsCustomAttributesAllowed is set to true). Attribute id will be based on the ID provided in the GetAttributesByCategory call).
AttributeValue	`String`	Value set by the customer for the given attribute.

`ProductVariation`

Field Name	Type	Description
SKU	`String`	Variation child SKU.
Title	`String`	Variation child title.
Quantity	`Integer`	Variation child available quantity.
Images	`ProductImage[]`	See description above in ProductImage table.
Price	`Decimal`	Variation listing price.
OptionValues	`VariationOption[]`	Option values set for given variation item. See VariationOption table.
AttributeSettings	`ListingAttribute[]`	List of attributes for this variation child item. See ListingAttribute table.

`VariationOption`

Field Name	Type	Description
Value	`ProductOptionValue`	The value set for this variation option for the given variation item (e.g. "S" or "M" ). See ProductOptionValue table.
Position	`Integer`	The position this option name should be used (e.g. size should be before colour).
Name	`String`	Option name (e.g. "Size").

`ProductOptionValue`

Field Name	Type	Description
Position	`Integer`	Which position this option value should be displayed for this option.
Value	`String`	Option value (e.g. "S", "M", "L").

`ProductOption`

Field Name	Type	Description
Values	`ProductOptionValue`	All available values associated with this option name. See ProductOptionValue table.
Position	`Integer`	The position this option name should be used (e.g. size should be before colour).
Name	`String`	Option name (e.g. "Size").

`ConfiguratorGeneralSetting`

Field Name	Type	Description
ConfiguratorId	`Integer`	Related configurator Id.
Settings	`ProductSettings`	Product Setting.

`ProductSettings`

Field Name	Type	Description
PaymentMethods	`String[]`	String list of payment methods.
GeneralSettings	`Setting[]`	Settings that were set with the GENERAL GroupNameValueType
ReturnsSettings	`Setting[]`	Settings that were set with the RETURN GroupNameValueType
ShippingSettings	`Setting[]`	Settings that were set with the SHIPPING GroupNameValueType
PaymentSettings	`Setting[]`	Settings that were set with the PAYMENT GroupNameValueType
VariationSettings	`Setting[]`	Settings that were set with the VARIATION GroupNameValueType
AttributeSettings	`Setting[]`	Unused.

`Setting`

Field Name	Type	Description
ID	`String`	ConfigItemId that was provided in GetConfiguratorSettings call.
Value	`String[]`	Customer selected value for this setting.

Sample

{
  "AuthorizationToken": "0dfdbaf3e4d5434f825e774e31bcc148",
  "Listings": [
    {
      "Attributes": [
        {
          "AttributeID": "Brand Name",
          "AttributeValue": "CoolProducts",
          "IsCustomAttribute": false
        },
        {
          "AttributeID": "Condition",
          "AttributeValue": "new",
          "IsCustomAttribute": false
        }
      ],
      "Categories": [
        "3"
      ],
      "ConfiguratorId": 13,
      "Description": "This is a high quality item",
      "ExternalListingId": "",
      "Images": [
        {
          "Tags": [
            "Main_image"
          ],
          "Url": "https://server.com/images.linnlive.com/f9a059eb1008300ab7eea8d586dd5000/bf24d3f3-1830-4ad4-ad8e-f01b9bbb00f1.jpg"
        },
        {
          "Tags": [
            "Main_image"
          ],
          "Url": "https://server.com/images.linnlive.com/f9a059eb1008300ab7eea8d586dd5000/bf24d3f3-1830-4ad4-ad8e-f01b9bbb00f1.jpg"
        }
      ],
      "Price": 10,
      "Quantity": 1,
      "SKU": "XYZ",
      "ShippingMethods": [
        {}
      ],
      "TemplateId": 2,
      "Title": "T-shirt",
      "VariationOptions": [
        {
          "Name": "Gender",
          "Position": 1,
          "Values": [
            {
              "Position": 1,
              "value": "Women"
            },
            {
              "Position": 2,
              "value": "Men"
            }
          ]
        }
      ],
      "Variations": [
        {
          "AttributeSettings": [
            {}
          ],
          "Images": [
            {}
          ],
          "OptionValues": [
            {
              "Name": "Gender",
              "Position": 1,
              "Value": "Women"
            }
          ],
          "Price": 10,
          "Quantity": 5,
          "SKU": "XYZ-1",
          "Title": "Nice Women’s T-shirt. One size."
        },
        {
          "AttributeSettings": [
            {}
          ],
          "Images": [
            {}
          ],
          "OptionValues": [
            {
              "Name": "Gender",
              "Position": 2,
              "Value": "Men"
            }
          ],
          "Price": 10,
          "Quantity": 3,
          "SKU": "XYZ-2",
          "Title": "Nice Men’s T-shirt. One size."
        }
      ],
      "Settings": [
        {
          "ConfiguratorId": 13,
          "Settings": {
            "GeneralSettings": [
              {}
            ],
            "PaymentMethods": [],
            "PaymentSettings": [
              {}
            ],
            "ReturnsSettings": [
              {
                "ID": "ReturnCost",
                "Values": [
                  "Buyer"
                ]
              },
              {
                "ID": "ReturnDays",
                "Values": [
                  "14"
                ]
              }
            ],
            "ShippingSettings": [
              {
                "ID": "ShippedFromCountry",
                "Values": [
                  "United Kingdom"
                ]
              },
              {
                "ID": "ShippedFromTown",
                "Values": [
                  "Chichester"
                ]
              },
              {
                "ID": "ShippedFromPostCode",
                "Values": [
                  "PO19 8DJ"
                ]
              }
            ],
            "VariationSettings": [
              {
                "ID": "VariationTheme",
                "Values": [
                  "Color-Size"
                ]
              }
            ]
          }
        }
      ],
      "Type": "CREATE"
    }
  ]
}

Response

`ProductsListingResponse`

Field Name	Type	Description
ChannelFeedId	`String`	Id for the feed that corresponds to the batch of products that were created, updated or deleted. If the channel does not use feeds, a feed id needs to be generated by the external developer.
Error	`String`	Defines if there was an error with the request and returns it.

Sample

{
  "ChannelFeedId": "123",
  "Error": null
}