> For the complete documentation index, see [llms.txt](https://help.orderdesk.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.orderdesk.com/integration-setup-guides/sales-channels/logicbroker-integration.md).

# Logicbroker Integration

Order Desk can connect to your [Logicbroker](https://www.logicbroker.com/) account and automatically download orders.

### Setup

In Order Desk, click on **Manage Integrations** under the Integrations menu in the left sidebar. Under the **Shopping Carts** tab, find and enable Logicbroker.

![](https://251457507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQOLMUJWMYtrpQ7Oxxca%2Fuploads%2F9TuZzCx3eIiWkAhFslaq%2Flegacy-c8520d0444b792405e5a.jpg?alt=media)

Alternatively, search for Logicbroker from the available integration search.

![](https://251457507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQOLMUJWMYtrpQ7Oxxca%2Fuploads%2F4S1fIWrSNS9ECpvBpj3G%2Flegacy-95b2d0814bfaa4434599.png?alt=media)

To connect to Order Desk, choose either the Production or Staging environment and enter your Logicbroker API key. Note that Order Desk cannot provide or reset your credentials and must be provided directly by Logicbroker. To retrieve your API key, log in to the Logicbroker portal and go to Settings → API Authentication.

![](https://251457507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQOLMUJWMYtrpQ7Oxxca%2Fuploads%2Fvr22fQBEulea3MldzFAW%2Flegacy-cdef2785761bed174bfe.png?alt=media)

Separate API credentials are needed for the [Production Portal](https://portal.logicbroker.com/) and [Stage Portal](https://stageportal.logicbroker.com/) portals.

### Integration Settings

![](https://d33v4339jhl8k0.cloudfront.net/docs/assets/57b0032590336059d4edf94f/images/6936d803c4947310519fe99f/file-3vrjuojoxa.png)

#### Logicbroker Help

![](https://d33v4339jhl8k0.cloudfront.net/docs/assets/57b0032590336059d4edf94f/images/64433c6335387a4818397318/file-mHbKOUkimT.gif)

Click *Need Help Getting Started?* for access to helpful resources for using Logicbroker.

#### Check for New Orders

Select how often you want Order Desk to download orders from Logicbroker.

#### Folder for New Orders

Select the folder where newly imported orders from Logicbroker should be placed.

For more information, see the [Working with Folders](/start-here/getting-started-series/quick-start-overview.md#working-with-folders) guide.

#### Order Import Delay

Use to set a time delay to give orders a chance to be edited prior to automatically importing to Order Desk.

#### Order Status

Select the status of the orders to be imported.

#### Order Number Source

Choose which value Order Desk should use as the order number for incoming orders. You can either use the original Order Number or the LogicBroker ID.

#### Sync Tracking Numbers

If the Sync Tracking Numbers setting is enabled, Order Desk will send the shipment information back to Logicbroker automatically and update the orders there.

#### Send Invoices

If the Send Invoices setting is enabled, Order Desk will send the invoices back to Logicbroker automatically.

#### Auto Accept Orders

Select to send Logicbroker acknowledgement of order receipt on import.

#### Sync Inventory

Select to send Order Desk inventory counts to Logicbroker.

#### Inventory Partner Target

Use the dropdown to select your preferred default partner or partners for inventory sync.

#### Download Packing Slips

Select to automatically download packing slips from Logicbroker with your orders.

#### Packing Slip Format

Once selected, packing slips will be downloaded from Logicbroker in this format by default.

#### Order Line Attribute Filter

Use this field to to specify item attribute names to import. Multiple values can be separated by commas. If blank, all items will be imported.

#### Inventory Location Filter

If you only want to download specific orders, you can use the Inventory Location Filter field to specify which ones you want. Enter multiple locations separated by a comma.

The inventory location name must match exactly as it is on your inventory items in Order Desk. When importing new orders from Logicbroker, Order Desk will look at the SKUs on the items and compare to the SKUs in your inventory here. Any orders with items for a location that isn’t listed in this field will not be imported.

For this to work, your inventory must be added to Order Desk. The inventory Location should be set on each item. For details, please see [How to Add Inventory](/start-here/getting-started-series/quick-start-orders-and-inventory.md#working-with-inventory) and [How to Store Extra Item Details](/guided-walkthroughs/products-and-inventory/how-to-work-with-inventory-details.md#store-extra-item-details-in-order-desk).

#### Order Prefix

Add a prefix of your choice that will be added to all orders downloaded from Logicbroker.

#### Inventory Whitelist Required

Select to require inventory whitelist for items. If checked, items will require an item metadata field of **logicbroker\_include** with a value of 1 to be synced. If left unchecked, all Order Desk inventory will be processed and new items will be created as needed.

#### Manually Import Orders

You can manually import orders from Logicbroker at any time. You can import orders by **Date** if you need to bring in multiple orders, or by a specific **Order ID** if you only need to import one order.

![](https://251457507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQOLMUJWMYtrpQ7Oxxca%2Fuploads%2FenlqwVDATuR4Pq7ilFIk%2Flegacy-2c6d2f04acde1052cc6f.png?alt=media)

> **Tip: Importing Orders by Date**
>
> If Logicbroker has a large number of orders in the selected date range, you may need to click the **Import** button a few times to bring them all in.

### Sending Orders to Logicbroker

#### Customize Order Details

You can add custom details to your orders to be passed through to Logicbroker. Add these details as checkout data or metadata fields. The field names must be an exact match to this table.

| Field Name    | Field Description                                                                                                             |
| ------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| InvoiceNumber | Overrides the invoice number upon invoice creation. Default will be set by our system.                                        |
| Carrier       | Overrides the carrier when submitting shipment back to Logicbroker. The default is the carrier of the shipment.               |
| ShipMethod    | Overrides the service level when submitting shipment back to Logicbroker. The default is the shipment method of the shipment. |
| Height        | Specify the height of the shipment.                                                                                           |
| Width         | Specify the width of the shipment.                                                                                            |
| Length        | Specify the length of the shipment.                                                                                           |

For instructions on how to apply these fields to checkout data, please read the [How to Work with Checkout Data guide](/guided-walkthroughs/orders-and-folders/how-to-work-with-checkout-data.md).

#### Preparing Your Items

The following fields can be set as variations or item metadata for each order item.

| Field Name           | Field Description                                                                                                                                                                |
| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| logicbroker\_include | If you have selected **Inventory Whitelist Required** in your Logicbroker integration settings, use this field with a value of **1** to confirm you would like an item included. |
| supplier\_sku        | Use to set supplier SKU. Default is item code.                                                                                                                                   |
| merchant\_sku        | Merchant SKU for the item.                                                                                                                                                       |
| upc                  | UPC for an individual item.                                                                                                                                                      |
| uom                  | Unit of measure for an individual item. Default is EA.                                                                                                                           |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.orderdesk.com/integration-setup-guides/sales-channels/logicbroker-integration.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.