Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

Listings /CreateBigcommerceTemplates

Allows 150 calls per minute

Response: PagedResult<BigCommerceListing>



Use this call to return a template based on the configurator setting you have requested. This allows you to see the template which can then be retuned to the ProcessBigCommerceListing endpoint which will build the listing.

Parameters

NameTypeDescription
parametersProcessTemplatesParametersObject of TemplatesParameters

Example Request

The following request format is required for this method.

Endpoint URL

POST https://eu-ext.linnworks.net/api/Listings/CreateBigcommerceTemplates

Headers

Connection: keep-alive
Accept: application/json
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

Request Body

This is an example of the request structure. Results will vary depending on your data.

parameters={
  "Source": "sample string 1",
  "SubSource": "sample string 2",
  "ConfigId": "e89d5f9c-b41d-452e-beb5-9b316bb3e37c",
  "InventoryItemIds": [
    "45367f7c-2860-4468-9c3a-e8c52d914a5a"
  ],
  "SelectedRegions": [
    {
      "Item1": 1,
      "Item2": 2
    }
  ],
  "Token": "cb6f1507-7269-4a00-94be-ef0882d7510d",
  "TemplatesType": 0
}

Response

This is an example of the response JSON. Results will vary depending on your data.

{
  "Items": [
    {
      "Adjustments": 64,
      "Width": 2.1,
      "Height": 3.1,
      "Depth": 4.1,
      "Attributes": [
        {
          "Name": "sample string 1",
          "Type": 0,
          "MaxLength": 2,
          "Label": "sample string 3",
          "Value": "sample string 4",
          "ExtendedProperty": "sample string 5",
          "Default": true
        }
      ],
      "VarAttributes": [
        {
          "Name": "sample string 1",
          "ExtendedProperty": "sample string 2",
          "Type": "sample string 3",
          "TypeLabel": "sample string 4"
        }
      ],
      "Children": [
        {
          "StockItemId": "f3b8dc67-8eea-4a4e-9f96-30cd86acb25a",
          "ChildId": "ff730d1f-560b-4984-88da-6b51fe7000e7",
          "SkuId": 3,
          "SKU": "sample string 4",
          "UPC": "sample string 5",
          "Name": "sample string 6",
          "Price": 7.1,
          "ManageStock": true,
          "CollisionNumber": 9,
          "Status": 0,
          "Quantity": 10,
          "Weight": 11.1,
          "InStockChannel": true,
          "ProductImageURL": "sample string 13",
          "OptionsValues": [
            {
              "OptionId": 1,
              "ValueId": 2,
              "Name": "sample string 3",
              "Label": "sample string 4"
            }
          ]
        }
      ],
      "OldChildren": [
        {
        }
      ],
      "OptionSet": {
        "Id": 1,
        "Name": "sample string 2",
        "MappedFromBC": true,
        "Options": [
          {
            "Id": 1,
            "IdV3": 2,
            "OptionName": "sample string 3",
            "OptionDisplayName": "sample string 4",
            "MappedFromBC": true,
            "AssignmentId": 6,
            "Values": [
              {
                "MappedFromBC": true,
                "Id": 1,
                "IdV3": 1,
                "SortOrder": 2,
                "Label": "sample string 3",
                "OptionValueData": {
                  "ImageUrl": "sample string 1",
                  "Color": "sample string 2"
                }
              }
            ],
            "Type": "sample string 7"
          }
        ]
      },
      "Images": [
        {
          "Id": 1,
          "Thumb": true,
          "sortOrder": 3,
          "IsChild": true,
          "ImageId": "6b3dbe9d-085a-4bf8-8423-3b7ede6dd582",
          "URL": "sample string 6",
          "Label": "sample string 7",
          "Show": true,
          "IsNative": true
        }
      ],
      "Version": 5,
      "ListingId": "58c32de3-4c58-49a3-98e0-cf1bd09e052c",
      "TemplateId": "62411401-d0a5-42a1-bbab-035c89d2a724",
      "InventoryItemId": "f68da62e-c1b6-4258-87c8-7bce4e5e02cb",
      "ConfigId": "9e61ffe6-0a36-48ac-9f20-0651b81689ba",
      "UsedConfigName": "sample string 10",
      "ProductId": 11,
      "UpdateConfig": true,
      "Type": 0,
      "ListingURL": "sample string 13",
      "Name": "sample string 14",
      "Description": "sample string 15",
      "ShortDescription": "sample string 16",
      "SKU": "sample string 17",
      "Barcode": "sample string 18",
      "TitleSource": "sample string 19",
      "Price": 20.1,
      "Weight": 21.1,
      "ShowListing": true,
      "ManageStock": true,
      "Quantity": 24,
      "IsReadOnly": true,
      "Categories": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2",
          "Path": "sample string 3",
          "Default": true
        }
      ],
      "HasCollisions": true,
      "UseMainItemImages": true,
      "Status": 0,
      "Site": "sample string 28",
      "IsErrorMsg": true,
      "CustomFields": [
        {
          "Id": 1,
          "BigCommerceId": 2,
          "FlexSettingsItemId": "c36f6bf8-9d6d-4f11-bcf4-0d8b0ac14e1a",
          "Name": "sample string 4",
          "Value": "sample string 5"
        }
      ]
    }
  ],
  "TotalItems": 1,
  "CurrentPage": 2,
  "EntriesPerPage": 3
}