Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

Listings /GetBigCommerceTemplates

Allows 150 calls per minute

Response: PagedResult<BigCommerceListing>



Use this call to return all created Big Commerce templates.

Parameters

NameTypeDescription
parametersGetTemplatesParametersObject of TemplatesParameters

Example Request

The following request format is required for this method.

Endpoint URL

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

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={
  "TemplateIds": [
    "910bac0e-897f-4697-9c9f-66944c507d6c"
  ],
  "OnlyWithErrors": true,
  "Source": "sample string 2",
  "SubSource": "sample string 3",
  "ConfigId": "fc826b22-3ca7-4ba2-a53a-04dbcfe6fc93",
  "InventoryItemIds": [
    "68ad1fb4-28d3-4ca0-bd9a-bb8ee5e94fd2"
  ],
  "SelectedRegions": [
    {
      "Item1": 1,
      "Item2": 2
    }
  ],
  "Token": "68041b1c-e075-414b-8288-eb72c1cc0ab4",
  "TemplatesType": 0,
  "PageNumber": 1,
  "EntriesPerPage": 2,
  "SiteFilter": {
    "Source": "sample string 1",
    "SubSource": "sample string 2",
    "Sites": "sample string 3",
    "SelectedSites": [
      "sample string 3"
    ]
  }
}

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": "a0147cda-ee14-45e0-b155-7add18182ea0",
          "ChildId": "65742a47-1801-452e-af4a-cd199dbcbfc8",
          "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": "9b3307d4-2d55-4986-bb12-98e84c2b3322",
          "URL": "sample string 6",
          "Label": "sample string 7",
          "Show": true,
          "IsNative": true
        }
      ],
      "Version": 5,
      "ListingId": "b05fe0e5-d2f3-4269-a147-690c75ff0c34",
      "TemplateId": "2906d561-e9c4-46c3-bf10-2bab8cc91776",
      "InventoryItemId": "1cc9eaa9-c36e-4d3e-9947-9b83762728cc",
      "ConfigId": "e93f57be-ee1c-461d-974e-4f3aaca90ee6",
      "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": "40b3beb1-ea4f-4418-b5bf-7d8e1d57c0c9",
          "Name": "sample string 4",
          "Value": "sample string 5"
        }
      ]
    }
  ],
  "TotalItems": 1,
  "CurrentPage": 2,
  "EntriesPerPage": 3
}