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

GET | 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": [
    "c182b3dd-ce85-4c58-abec-b33b5e3afed6"
  ],
  "OnlyWithErrors": true,
  "Source": "sample string 2",
  "SubSource": "sample string 3",
  "ConfigId": "070133ec-8950-4716-a799-8fd10b2734d4",
  "InventoryItemIds": [
    "58a641e8-d5f2-423e-8c43-ac5d4bbc60d0"
  ],
  "SelectedRegions": [
    {
      "Item1": 1,
      "Item2": 2
    }
  ],
  "Token": "2d03b10b-90da-4803-b7ee-86e5dcdddde2",
  "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": "b0e3eb8d-46c9-48a9-bd2e-d111bc5765d3",
          "ChildId": "598a0774-1dc1-4731-90f3-e5689d39622e",
          "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": "4e435fdc-16f4-41f0-87e0-747636e8af82",
          "URL": "sample string 6",
          "Label": "sample string 7",
          "Show": true,
          "IsNative": true
        }
      ],
      "Version": 5,
      "ListingId": "7fe1ecbe-d1dd-4e35-b8d6-1c3b9dcf62fa",
      "TemplateId": "5ad5e55c-369b-40b5-a80f-176b1c69c51c",
      "InventoryItemId": "32ccd25a-90a4-4f86-8c1c-ea21b808f90d",
      "ConfigId": "75a1ff7f-04d5-429b-94ad-da7396feb0bd",
      "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": "cea4a80d-6df9-4cde-a22e-5bc69014bd62",
          "Name": "sample string 4",
          "Value": "sample string 5"
        }
      ]
    }
  ],
  "TotalItems": 1,
  "CurrentPage": 2,
  "EntriesPerPage": 3
}