### Get Configurator Settings - Sample Request

Source: https://apidocs.linnworks.net/docs/channel-integration-endpoint-get-configurator-settings

This snippet shows a sample request for the Get Configurator Settings endpoint. It demonstrates that no parameters or content are required for this request.

```json
{
}
```

--------------------------------

### Example Channel Integration in LinnworksNetSDK

Source: https://apidocs.linnworks.net/docs/channel-integration

This snippet points to an example of a channel integration within the LinnworksNetSDK repository on GitHub. It serves as a practical reference for developers looking to implement their own channel integrations.

```link
https://github.com/LinnSystems/LinnworksNetSDK/tree/master/Linnworks/Examples/SampleChannel
```

--------------------------------

### Example HTTP GET Request

Source: https://apidocs.linnworks.net/reference/gettopproducts

This snippet demonstrates an example HTTP GET request to the GetTopProducts endpoint. It includes query parameters for specifying the report type, period, and number of rows, along with the necessary Authorization header.

```http
GET /api/Dashboards/GetTopProducts?type=GroupedByQuantity&period=12&numRows=10 HTTP/1.1
Host: eu-ext.linnworks.net
Authorization: token YOUR_API_TOKEN
```

--------------------------------

### Example HTTP GET Request for Stock Consumption

Source: https://apidocs.linnworks.net/reference/getstockconsumption

This example demonstrates how to make an HTTP GET request to the GetStockConsumption endpoint. It includes query parameters for stock item ID, location ID, and date range, along with the necessary authorization header.

```http
GET /api/Stock/GetStockConsumption?stockItemId=00000000-0000-0000-0000-000000000000&locationId=00000000-0000-0000-0000-000000000000&startDate=2023-01-01T00:00:00&endDate=2023-12-31T23:59:59 HTTP/1.1
Host: eu-ext.linnworks.net
Authorization: token YOUR_API_TOKEN
```

--------------------------------

### Post Sale Options Request Example (JSON)

Source: https://apidocs.linnworks.net/docs/channel-integration-endpoint-post-sale-options

This JSON snippet demonstrates a sample request to the Post Sale Options endpoint. It includes the AuthorizationToken required for customer integration.

```json
{
  "AuthorizationToken": "0dfdbaf3e4d5434f825e774e31bcc148"
}
```

--------------------------------

### Get Installed Macros OpenAPI Definition

Source: https://apidocs.linnworks.net/reference/getinstalledmacros

This OpenAPI 3.0 definition outlines the structure and details for the GetInstalledMacros endpoint. It specifies the request method (GET), required permissions, rate limits, and the expected response schema, including details about installed macros and their parameters.

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "macro",
    "title": "Macros API"
  },
  "paths": {
    "/api/Macro/GetInstalledMacros": {
      "get": {
        "tags": [
          "Macro"
        ],
        "summary": "GetInstalledMacros",
        "description": "Get a list of all macros and their related applications as installed on the users system\n<b>Permissions Required: </b> GlobalPermissions.Applications.MacroConfigurationNode\n<b>Rate limit: </b><span style=\"background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;\"><b>150</b></span> / minute",
        "operationId": "GetInstalledMacros",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetInstalledMacrosResponse"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetInstalledMacrosResponse"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/GetInstalledMacrosResponse"
                }
              },
              "text/xml": {
                "schema": {
                  "$ref": "#/components/schemas/GetInstalledMacrosResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "token": [
              "token"
            ]
          }
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://eu-ext.linnworks.net"
    }
  ],
  "components": {
    "securitySchemes": {
      "token": {
        "type": "apiKey",
        "description": "Authorization Header",
        "name": "Authorization",
        "in": "header"
      }
    },
    "schemas": {
      "GetInstalledMacrosResponse": {
        "type": "object",
        "properties": {
          "Macros": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/InstalledMacro"
            }
          }
        }
      },
      "InstalledMacro": {
        "type": "object",
        "properties": {
          "ApplicationName": {
            "type": "string"
          },
          "ApplicationLogo": {
            "type": "string"
          },
          "MacroName": {
            "type": "string"
          },
          "MacroDescription": {
            "type": "string"
          },
          "ExecutionType": {
            "enum": [
              "API",
              "Scheduled",
              "RulesEngine_Order"
            ],
            "type": "string"
          },
          "SourceCodeType": {
            "enum": [
              "netcore10",
              "netcore21",
              "netcore31",
              "net6",
              "net8"
            ],
            "type": "string"
          },
          "Parameters": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ParameterDefinition"
            }
          }
        }
      },
      "ParameterDefinition": {
        "type": "object",
        "properties": {
          "Type": {
            "type": "string"
          },
          "Name": {
            "type": "string"
          },
          "IsRequired": {
            "type": "boolean"
          },
          "DefaultValue": {
            "type": "string"
          },
          "FriendlyName": {
            "type": "string"
          },
          "ParameterDescription": {
            "type": "string"
          },
          "RegexValidation": {
            "type": "string"
          },
          "RegexErrorMessage": {
            "type": "string"
          },
          "MustBeSpecified1": {
            "type": "boolean"
          },
          "isHidden": {
            "type": "boolean"
          },
          "isReadOnly": {
            "type": "boolean"
          },
          "IsSecure": {
            "type": "boolean"
          },
          "GroupName": {
            "type": "string"
          },
          "Sortorder": {
            "format": "int32",
            "type": "integer"
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": "6454fb0267be7d1325fdea68"
}
```

--------------------------------

### Create Generic Listing Templates

Source: https://apidocs.linnworks.net/reference/createtemplates

This endpoint creates a generic template for a channel listing using inventory item and configurator details. It requires specifying the channel type, channel name, and optionally parameters for inventory search and pagination. Permissions for 'GlobalPermissions.ListingConfigurators.GetListingConfiguratorsNode' are necessary.

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "genericlistings",
    "title": "Generic Listings API"
  },
  "paths": {
    "/api/GenericListings/CreateTemplates": {
      "post": {
        "tags": [
          "GenericListings"
        ],
        "summary": "CreateTemplates",
        "description": "Use this call to create a generic template based on the inventory item details and the configurator details. This template will contain the full details of the item that will be listed on the channel.\n<b>Permissions Required: </b> GlobalPermissions.Settings.ListingConfigurators.GetListingConfiguratorsNode\n<b>Rate limit: </b><span style=\"background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;\"><b>150</b></span> / minute",
        "operationId": "CreateTemplates",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/GenericListings_CreateTemplatesRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateTemplatesResponse"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateTemplatesResponse"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/CreateTemplatesResponse"
                }
              },
              "text/xml": {
                "schema": {
                  "$ref": "#/components/schemas/CreateTemplatesResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "token": [
              "token"
            ]
          }
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://eu-ext.linnworks.net"
    }
  ],
  "components": {
    "securitySchemes": {
      "token": {
        "type": "apiKey",
        "description": "Authorization Header",
        "name": "Authorization",
        "in": "header"
      }
    },
    "schemas": {
      "GenericListings_CreateTemplatesRequest": {
        "type": "object",
        "properties": {
          "request": {
            "$ref": "#/components/schemas/CreateTemplatesRequest"
          }
        }
      },
      "CreateTemplatesRequest": {
        "type": "object",
        "properties": {
          "ChannelType": {
            "enum": [
              "CDiscount",
              "Shopify",
              "Magento",
              "External",
              "Walmart",
              "TikTok",
              "Amazon"
            ],
            "type": "string"
          },
          "ChannelName": {
            "type": "string"
          },
          "Parameters": {
            "$ref": "#/components/schemas/InventorySearchParameters"
          },
          "PaginationParameters": {
            "$ref": "#/components/schemas/PaginationParameters"
          },
          "ConfiguratorId": {
            "format": "int32",
            "type": "integer"
          }
        }
      },
      "InventorySearchParameters": {
        "type": "object",
        "properties": {
          "SelectedRegions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Tuple_Int32_Int32"
            }
          },
          "Token": {
            "format": "uuid",
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000"
          },
          "InventoryItemIds": {
            "type": "array",
            "items": {
              "format": "uuid",
              "type": "string",
              "example": "00000000-0000-0000-0000-000000000000"
            }
          },
          "ChannelId": {
            "format": "int32",
            "type": "integer"
          }
        }
      },
      "PaginationParameters": {
        "type": "object",
        "properties": {
          "PageNumber": {
            "format": "int32",
            "type": "integer"
          },
          "EntriesPerPage": {
            "format": "int32",
            "type": "integer"
          }
        }
      },
      "Tuple_Int32_Int32": {
        "type": "object",
        "properties": {
          "Item1": {
            "format": "int32",
            "type": "integer",
            "readOnly": true
          },
          "Item2": {
            "format": "int32",
            "type": "integer",
            "readOnly": true
          }
        }
      },
      "CreateTemplatesResponse": {
        "type": "object",
        "properties": {
          "TemplatesInfo": {
            "type": "array",
            "items": {
              "type": "object"
            }
          }
        }
      }
    }
  }
}
```

--------------------------------

### GetOrderRelations HTTP Request Example

Source: https://apidocs.linnworks.net/reference/getorderrelations

An example HTTP GET request to the GetOrderRelations endpoint, including the base URL and query parameters.

```http
GET /api/Orders/GetOrderRelations?orderId=YOUR_ORDER_ID_HERE HTTP/1.1
Host: eu-ext.linnworks.net
Authorization: token YOUR_API_TOKEN_HERE
```

--------------------------------

### Initialize Base Master Page Parameters

Source: https://docs.linnworks.com/articles/

Sets up parameters for the base master page, including UI branding, language settings, and publication-specific configurations. This is used for customizing the portal's appearance and behavior.

```javascript
//<!-- var baseMasterLoginUrlMask = '/login/?ReturnUrl=RETURN_URL&error=no'; //-->
//<!-- var baseMasterSearchUrlMask = '/search/#q/SEARCH_QUERY/p/PROJECT_EXT_ID'; //-->
```

--------------------------------

### GetTemplateList HTTP Request Example

Source: https://apidocs.linnworks.net/reference/gettemplatelist

Example of an HTTP GET request to retrieve a list of templates for a specific type. The 'templateType' query parameter filters the results.

```http
GET /api/PrintService/GetTemplateList?templateType=Warehouse Transfer HTTP/1.1
Host: eu-ext.linnworks.net
Authorization: token YOUR_TOKEN_HERE
```

--------------------------------

### Configure Quick Filter Box Instance

Source: https://docs.linnworks.com/articles/

Creates an instance of the QuickFilterBox class, configuring its behavior, event handlers, and associations with other UI components.

```JavaScript
window['CI__1842297401'] = new QuickFilterBox('CI__811583954', 200, false, 'CI__1582737543', 'CI__838494745', '[Custom Filter]', false, 'CI__1313066450', 'Topic filter');
window['CI__1842297401'].onFilterChanged = function(s, e) {
    window['CI__1226097961'].onChangedFilter(s, e);
};
window['CI__1842297401'].onButtonClicked = function(s, e) {
    window['CI__1226097961'].onEditorButtonClicked(s, e);
};
window['CI__1842297401'].onGotFocus = function(s, e) {
    window['CI__1226097961'].onEditorGotFocus(s, e);
};
window['CI__1842297401'].onKeyDown = function(s, e) {
    window['CI__1226097961'].onEditorKeyDown(s, e);
};
```

--------------------------------

### GetStockAvailability HTTP Request Example

Source: https://apidocs.linnworks.net/reference/getstockavailability

Example of an HTTP GET request to the GetStockAvailability endpoint. This demonstrates how to call the API to retrieve stock availability for a specific transfer item ID.

```http
GET /api/WarehouseTransfer/GetStockAvailability?pkTransferItemId=00000000-0000-0000-0000-000000000000 HTTP/1.1
Host: eu-ext.linnworks.net
Authorization: Bearer YOUR_ACCESS_TOKEN
```

--------------------------------

### Linnworks Ebay Prices Schema

Source: https://apidocs.linnworks.net/reference/processebaylistings

Defines the pricing structure for Ebay listings, including start price, reserve price, BIN price, and auto-accept/decline values.

```json
{
  "type": "object",
  "properties": {
    "StartPrice": {
      "format": "double",
      "type": "number"
    },
    "ReservePrice": {
      "format": "double",
      "type": "number"
    },
    "BINPrice": {
      "format": "double",
      "type": "number"
    },
    "AutoAccept": {
      "format": "double",
      "type": "number"
    },
    "AutoDecline": {
      "format": "double",
      "type": "number"
    },
    "OriginalRetailPrice": {
      "format": "double",
      "type": "number"
    }
  }
}
```

--------------------------------

### Get Archived Warehouse Transfers by Date Range

Source: https://apidocs.linnworks.net/reference/getarchivedtransfersbetweendates

Retrieves a paginated list of archived warehouse transfers created between a specified start and end date. Requires GlobalPermissions.Inventory.WarehouseTransferNode. The API has a rate limit of 150 requests per minute.

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "warehousetransfer",
    "title": "Warehouse Transfer (Legacy) API"
  },
  "paths": {
    "/api/WarehouseTransfer/GetArchivedTransfersBetweenDates": {
      "get": {
        "tags": [
          "WarehouseTransfer"
        ],
        "summary": "GetArchivedTransfersBetweenDates",
        "description": "Use this call to search for archived transfers which were created between two dates.\n<b>Permissions Required: </b> GlobalPermissions.Inventory.WarehouseTransferNode\n<b>Rate limit: </b><span style=\"background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;\"><b>150</b></span> / minute",
        "operationId": "GetArchivedTransfersBetweenDates",
        "parameters": [
          {
            "name": "start",
            "in": "query",
            "description": "The start date.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "end",
            "in": "query",
            "description": "The end date.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "pageNumber",
            "in": "query",
            "description": "The page number (starting at 1).",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "entriesPerPage",
            "in": "query",
            "description": "The number of entries to be returned per page.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GenericPagedResult_WarehouseTransfer"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/GenericPagedResult_WarehouseTransfer"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/GenericPagedResult_WarehouseTransfer"
                }
              },
              "text/xml": {
                "schema": {
                  "$ref": "#/components/schemas/GenericPagedResult_WarehouseTransfer"
                }
              }
            }
          }
        },
        "security": [
          {
            "token": [
              "token"
            ]
          }
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://eu-ext.linnworks.net"
    }
  ],
  "components": {
    "securitySchemes": {
      "token": {
        "type": "apiKey",
        "description": "Authorization Header",
        "name": "Authorization",
        "in": "header"
      }
    },
    "schemas": {
      "WarehouseTransfer": {
        "type": "object",
        "properties": {
          "PkTransferId": {
            "format": "uuid",
            "description": "Transfer ID",
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000"
          },
          "FromLocationId": {
            "format": "uuid",
            "description": "Location from which transfer is made (unique identifier)",
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000"
          },
          "ToLocationId": {
            "format": "uuid",
            "description": "Location to which transfer is made (unique identifier)",
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000"
          },
          "FromLocation": {
            "description": "Name of location from which transfer is made",
            "type": "string"
          },
          "ToLocation": {
            "description": "Name of location to which transfer is made",
            "type": "string"
          },
          "Status": {
            "description": "Current transfer status",
            "enum": [
              "Draft",
              "Request",
              "Accepted",
              "Packing",
              "InTransit",
              "CheckingIn",
              "Delivered"
            ],
            "type": "string"
          },
          "nStatus": {
            "format": "int32",
            "description": "Status ID",
            "type": "integer"
          },
          "ReferenceNumber": {
            "description": "Transfer reference number",
            "type": "string"
          },
          "OrderDate": {
            "format": "date-time",
            "description": "When transer was ordered",
            "type": "string"
          },
          "NumberOfItems": {
            "format": "int32",
            "description": "Number of items in the transfer",
            "type": "integer"
          }
        }
      },
      "GenericPagedResult_WarehouseTransfer": {
        "type": "object",
        "properties": {
          "Data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WarehouseTransfer"
            }
          },
          "TotalResults": {
            "format": "int32",
            "type": "integer"
          },
          "PageNumber": {
            "format": "int32",
            "type": "integer"
          },
          "EntriesPerPage": {
            "format": "int32",
            "type": "integer"
          }
        }
      }
    }
  }
}
```

--------------------------------

### Initialize Main Menu with Projects Popup

Source: https://docs.linnworks.com/articles/

Initializes the MainMenu component, linking it to a specific projects popup panel and defining the URL for the projects page.

```JavaScript
//<!-- window['CI__125781698']=new MainMenu({"menuName":"baseMasterMainMenu","pnlProjectsPopupName":"pnlContainer_templatedHeader_mainmenu_panelProjectsPopup","projectsPageLink":"/portal/dashboard"}); //-->
```

--------------------------------

### Get Stock Consumption Report (OpenAPI)

Source: https://apidocs.linnworks.net/reference/getstockconsumption

This OpenAPI definition outlines the GetStockConsumption endpoint for the Linnworks Stock API. It specifies the request parameters, including stock item ID, location ID, start date, and end date, as well as the structure of the returned stock consumption data.

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "stock",
    "title": "Stock API"
  },
  "paths": {
    "/api/Stock/GetStockConsumption": {
      "get": {
        "tags": [
          "Stock"
        ],
        "summary": "GetStockConsumption",
        "description": "Use this call to retrieve report about \"stock consumption between two dates\"\n<b>Rate limit: </b><span style=\"background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;\"><b>250</b></span> / minute",
        "operationId": "GetStockConsumption",
        "parameters": [
          {
            "name": "stockItemId",
            "in": "query",
            "description": "Used to specify report stock id",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "locationId",
            "in": "query",
            "description": "Used to specify location id. If null, then will return combined result of every location",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "startDate",
            "in": "query",
            "description": "Used to specify report start date",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "endDate",
            "in": "query",
            "description": "Used to specify report end date",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/StockConsumption"
                  }
                }
              },
              "text/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/StockConsumption"
                  }
                }
              },
              "application/xml": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/StockConsumption"
                  }
                }
              },
              "text/xml": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/StockConsumption"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "token": [
              "token"
            ]
          }
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://eu-ext.linnworks.net"
    }
  ],
  "components": {
    "securitySchemes": {
      "token": {
        "type": "apiKey",
        "description": "Authorization Header",
        "name": "Authorization",
        "in": "header"
      }
    },
    "schemas": {
      "StockConsumption": {
        "type": "object",
        "properties": {
          "Date": {
            "format": "date-time",
            "description": "When stock was sold",
            "type": "string"
          },
          "StockQuantity": {
            "format": "int32",
            "description": "Sold quantity",
            "type": "integer"
          },
          "StockValue": {
            "format": "double",
            "description": "Current stock value",
            "type": "number"
          },
          "Shipped": {
            "format": "int32",
            "description": "Shipped stock",
            "type": "integer"
          },
          "StockItemId": {
            "format": "uuid",
            "description": "Stock Item Id",
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000"
          },
          "StockItemIntId": {
            "format": "int32",
            "description": "Stock Item interger Id",
            "type": "integer"
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": "643e784d123d7e0025573244"
}
```

--------------------------------

### BigCommerce Product Pricing and Options

Source: https://apidocs.linnworks.net/reference/processbigcommercelistings

Defines the pricing structure (CostPrice, SalePrice, RetailPrice) and assigned options for BigCommerce products. It includes details about option sets, individual options, and their values, referencing specific schema definitions.

```json
{
  "CostPrice": {
    "format": "double",
    "type": "number"
  },
  "SalePrice": {
    "format": "double",
    "type": "number"
  },
  "RetailPrice": {
    "format": "double",
    "type": "number"
  }
}
{
  "type": "object",
  "properties": {
    "Id": {
      "format": "int32",
      "type": "integer"
    },
    "Name": {
      "type": "string"
    },
    "MappedFromBC": {
      "type": "boolean"
    },
    "Options": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AssignedOption"
      }
    }
  }
}
{
  "type": "object",
  "properties": {
    "OptionId": {
      "format": "int32",
      "type": "integer"
    },
    "ValueId": {
      "format": "int32",
      "type": "integer"
    },
    "Name": {
      "type": "string"
    },
    "Label": {
      "type": "string"
    },
    "SortOrder": {
      "format": "int32",
      "type": "integer"
    }
  }
}
{
  "type": "object",
  "properties": {
    "IdV3": {
      "format": "int32",
      "type": "integer"
    },
    "Id": {
      "format": "int32",
      "type": "integer"
    },
    "Values": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OptionValue"
      }
    },
    "OptionDisplayName": {
      "type": "string"
    },
    "OptionName": {
      "type": "string"
    },
    "MappedFromBC": {
      "type": "boolean"
    },
    "AssignmentId": {
      "format": "int32",
      "type": "integer"
    },
    "Type": {
      "type": "string"
    },
    "SortOrder": {
      "format": "int32",
      "type": "integer"
    }
  }
}
{
  "type": "object",
  "properties": {
    "IdV3": {
      "format": "int32",
      "type": "integer"
    },
    "Id": {
      "format": "int32",
      "type": "integer"
    },
    "MappedFromBC": {
      "type": "boolean"
    },
    "SortOrder": {
      "format": "int32",
      "type": "integer"
    },
    "Label": {
      "type": "string"
    },
    "OptionValueData": {
      "$ref": "#/components/schemas/OptionValueData"
    }
  }
}
{
  "type": "object",
  "properties": {
    "Color": {
      "type": "string"
    },
    "ImageUrl": {
      "type": "string"
    }
  }
}
```

--------------------------------

### EbayPrices Schema Definition

Source: https://apidocs.linnworks.net/reference/createebaytemplates

Defines the pricing structure for eBay listings, including StartPrice, ReservePrice, and Buy It Now (BIN) Price. These are represented as floating-point numbers.

```json
{
  "StartPrice": {
    "format": "double",
    "type": "number"
  },
  "ReservePrice": {
    "format": "double",
    "type": "number"
  },
  "BINPrice": {
    "format": "double",

```

--------------------------------

### Configure and Initialize Quick Filter

Source: https://docs.linnworks.com/articles/

Configures and initializes a quick filter input component, including validation, event handling for key presses and button clicks, and custom styling.

```JavaScript
ASPx.AddDisabledItems('pnlContainer_cphMain_articleSelector_tocTreeLight_quickFilter_quickFilter_edtFilter_edtQuickFilter', [['dxeDisabled_DefaultTheme', [], ['','I']]]);
ASPx.RemoveDisabledItems('pnlContainer_cphMain_articleSelector_tocTreeLight_quickFilter_quickFilter_edtFilter_edtQuickFilter', [['B-100','B0','B1','B2']]);
ASPx.createControl(ASPxClientButtonEdit, 'pnlContainer_cphMain_articleSelector_tocTreeLight_quickFilter_quickFilter_edtFilter_edtQuickFilter', 'CI__811583954', {
    'uniqueID': 'ctl00$pnlContainer$cphMain$articleSelector$tocTreeLight$quickFilter$quickFilter$edtFilter$edtQuickFilter',
    'scStates': 2,
    'scPostfix': 'DefaultTheme',
    'stateObject': {'rawValue': ''},
    'customValidationEnabled': true,
    'isValid': true,
    'errorText': 'Invalid value',
    'isErrorFrameRequired': true,
    'display': 'Dynamic',
    'errorDisplayMode': 'i',
    'errorImageIsAssigned': true,
    'controlCellStyles': {
        'cssClass': 'dxeErrorFrame_DefaultTheme dxeErrorFrameSys dxeNoBorderRight dxeControlsCell_DefaultTheme',
        'style': 'width:100%;'
    },
    'nullText': 'Filter topics by title...', 
    'autoCompleteAttribute': {'name': 'autocomplete', 'value': 'off'},
    'buttonCount': 3,
    'clearButtonDisplayMode': 'Never'
}, {
    'Init': function(s, e) { window['CI__1842297401'].onTextBoxInit(s, e); },
    'KeyDown': function(s, e) { window['CI__1842297401'].onTextBoxKeyDown(s, e); },
    'KeyUp': function(s, e) { window['CI__1842297401'].onTextBoxKeyUp(s, e); },
    'ButtonClick': function(s, e) { window['CI__1842297401'].onTextBoxButtonClick(s, e); }
}, null, {
    'decorationStyles': [
        {'key': 'I', 'className': 'dxeInvalid_DefaultTheme', 'cssText': ''},
        {'key': 'F', 'className': 'dxeFocused_DefaultTheme QuickFilterBox_focused', 'cssText': ''},
        {'key': 'N', 'className': 'dxeNullText_DefaultTheme QuickFilterBox_nullText', 'cssText': ''}
    ]
});
```

--------------------------------

### Get Attributes By Category Request (JSON)

Source: https://apidocs.linnworks.net/docs/channel-integration-endpoint-get-attributes-by-category

This JSON object represents a sample request to the Get Attributes By Category endpoint. It includes an authorization token, an array of category IDs, and an array for general settings.

```json
{
  "AuthorizationToken": "0dfdbaf3e4d5434f825e774e31bcc148",
  "CategoryIds": [
    "3",
    "8"
  ],
  "GeneralSettings": []
}
```

--------------------------------

### Sample Linnworks Product Feed Response

Source: https://apidocs.linnworks.net/docs/channel-integration-endpoint-checkfeed

An example JSON response from the Linnworks product feed API. It includes a status indicating if the feed is ready, and a list of product feeds with channel references, external listing IDs, and potential messages.

```json
{
  "Error": null,
  "IsFeedReady": true,
  "ProductFeeds": [
    {
      "ChannelReferences": [
        {
          "Reference": "p145-n18-v75",
          "SKU": "XYZ-1"
        },
        {
          "Reference": "p145-n18-v76",
          "SKU": "XYZ-3"
        }
      ],
      "ExternalListingId": "1122",
      "Messages": null,
      "SKU": "XYZ",
      "TemplateId": 14,
      "URL": "http://www.mysite.co.uk/tshirt.html"
    }
  ]
}
```

--------------------------------

### Linnworks API: Shipment Box Management

Source: https://apidocs.linnworks.net/v2/

Manages shipment boxes for warehouse transfers. Supports adding, updating, getting, deleting, and getting shipment boxes by shipment ID. These are POST, PUT, GET, and DELETE requests to endpoints under /v2/reference/post_warehousetransfer-fba-inbound-shipping-plans-shippingplanid-boxes.

```REST
POST /v2/reference/post_warehousetransfer-fba-inbound-shipping-plans-shippingplanid-boxes
PUT /v2/reference/put_warehousetransfer-fba-inbound-shipping-plans-shippingplanid-boxes
GET /v2/reference/get_warehousetransfer-fba-inbound-shipping-plans-shippingplanid-boxes
DELETE /v2/reference/delete_warehousetransfer-fba-inbound-shipping-plans-shippingplanid-boxes-shipmentboxid
GET /v2/reference/get_warehousetransfer-fba-inbound-shipping-plans-shippingplanid-boxes-shipmentid
```

--------------------------------

### Sample Linnworks API Response

Source: https://apidocs.linnworks.net/docs/channel-integration-endpoint-post-sale-options

This JSON object represents a sample response from the Linnworks API, indicating various cancellation and refund capabilities for an order.

```json
{
  "Error": null,
  "CanCancel": true,
  "CanCancelOrderLines": true,
  "CanCancelOrderLinesPartially": true,
  "AutomaticRefundOnCancel": false,
  "CanRefund": true,
  "CanAttachRefundToItem": true,
  "CanAttachRefundToService": false,
  "RefundShippingTypes": 0,
  "CanRefundAdditionally": false,
  "CanReturn": false
}
```

--------------------------------

### Linnworks API: Get Channel by ID

Source: https://apidocs.linnworks.net/v2/

Retrieves channel information by its ID. This is a GET request to the /v2/reference/getchannelbyidasync endpoint.

```REST
GET /v2/reference/getchannelbyidasync
```

--------------------------------

### Selection List Configuration Schema (GUID)

Source: https://apidocs.linnworks.net/reference/getchannelsbysource

Defines a configuration item that is a selection list of GUID values. Used for selecting specific identifiers from a list.

```json
{
  "$ref": "#/components/schemas/ConfigPropertySelectionList_SelectStringValueOption_Guid"
}
```

--------------------------------

### StockItemInfo Schema

Source: https://apidocs.linnworks.net/reference/updatepickingwaveitemwithnewbinrack

Provides basic stock item information, including SKU, StockItemId, ItemTitle, Barcode, PrimaryImageURL, and a list of product identifiers.

```json
{
  "description": "Basic stock item information",
  "type": "object",
  "properties": {
    "SKU": {
      "description": "Item SKU",
      "type": "string"
    },
    "StockItemId": {
      "format": "uuid",
      "description": "Item unique id",
      "type": "string",
      "example": "00000000-0000-0000-0000-000000000000"
    },
    "ItemTitle": {
      "description": "Item Title",
      "type": "string"
    },
    "Barcode": {
      "description": "Barcode number on the item header",
      "type": "string"
    },
    "PrimaryImageURL": {
      "description": "Image URL",
      "type": "string"
    },
    "Identifiers": {
      "description": "Product identifiers",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StockItemIdentifier"
      }
    }
  }
}
```