Logicbroker

https://help.logicbroker.com/hc/en-us
Admin
Logicbroker is an EDI and integration platform that enables retailers and suppliers to connect,...
Tokens:334,510
Snippets:3,253
Trust Score:9.7
Update:7 months ago
Show doc for...
Tokens:
Raw
### EDI Return Document with Loops Example

Source: https://help.logicbroker.com/hc/en-us/articles/360021911472

Demonstrates how loops, such as those for line items in EDI return documents, are represented. The example shows the BLI segment and the nested RDR segment, indicating a loop structure for return line details.

```edi
BLI*VN*V-123123*1*EA****IN*1234567*UP*0123456789012~
**RDR**DR**TOO SMALL~**  
BLI*VN*V-1234568*1*EA****IN*123124*UP*0123456789013~
**RDR**DR**TOO BIG~
**

```

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

### EDI: Line Item Example with Qualifiers

Source: https://help.logicbroker.com/hc/en-us/articles/360022058331-Invoice-Specification

Illustrates how line items are represented in EDI, including loops and qualifiers. The example shows the BLI segment and associated RDR qualifiers.

```edi
BLI*VN*V-123123*1*EA****IN*1234567*UP*0123456789012~
**RDR**DR**TOO SMALL~
BLI*VN*V-1234568*1*EA****IN*123124*UP*0123456789013~
**RDR**DR**TOO BIG~
```

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

### Connector Setup

Source: https://help.logicbroker.com/hc/en-us/articles/15240650416788-The-Market

Steps to connect Logicbroker with TikTok Shop, including general settings and authentication.

```APIDOC
## Connector Setup

### Description
Follow these steps to connect Logicbroker to your TikTok Shop account.

### Method
N/A (This describes a setup process, not a direct API endpoint)

### Endpoint
N/A

### Steps
1.  From the Logicbroker portal, go to **Connections** > **Connect to a new system** > search for **TikTok**.
2.  Under **General**, enter the **Base URL** (production or sandbox depending on how you are testing through TikTok).
3.  If your shop is in the United States, set **Is US?** to **true**.
4.  Click on **Connect**. You will be prompted to choose your region, log in using your TikTok credentials, and install the app.
5.  Once connected, click on **Get Shops**.
6.  Copy the **Shop Cipher** you wish to connect to into the **Shop Cipher** field.
7.  **Save**.
```

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

### XML Order Structure Example

Source: https://help.logicbroker.com/hc/en-us/articles/360021847952

Illustrates the standard XML structure for an order, focusing on the ShipToAddress.CompanyName field. It also provides an example of how to incorporate custom fields via the ExtendedAttributes element.

```xml
  <ShipToAddress>
    <CompanyName>Merchant Co</CompanyName>
  </ShipToAddress>

```

```xml
  <ExtendedAttributes>
    <ExtendedAttribute>
      <Name>Example</Name>
      <Value>Portal</Value>
    </ExtendedAttribute>
    <ExtendedAttribute>
      <Name>Example2</Name>
      <Value>NewValue</Value>
    </ExtendedAttribute>
  </ExtendedAttributes>

```

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

### Return Request and Response Process

Source: https://help.logicbroker.com/hc/en-us/articles/360043855211-Shipments-Mark-Items-as-Shipped

This section details the process flow for customer returns initiated in Google Shopping Actions, processed by Logicbroker, and how to respond with refund information.

```APIDOC
## Process Flow: Google Shopping Actions Returns

### Overview
Customers can request a return within Google Shopping Actions, and the request is sent to Logicbroker. Logicbroker processes these requests on a 4-hour schedule. Upon receiving a physical return, a response can be created within Logicbroker to issue a refund. Refunds can be issued with or without an existing return request, and the refund amount per item can be edited.

The return request functionality operates like an RMA process. The end customer initiates the return from Google Shopping, providing carrier and tracking details for the expected return. This information is sent to Logicbroker and remains in the **Under Review** status.

Once the physical return is received, a response accepting the return with a refund amount is expected. This should integrate with your normal return integration process with Logicbroker. After the return response is sent, the original Return request will transition to the **Response Received** status.

### Field Descriptions for Returns

#### Return Request (From Google Shopping)

| Google Field | Logicbroker Field | Description | Notes | Requirement |
|---|---|---|---|---|
| **id** | **ExtendedAttribute[Name="GoogleOrderNumber"].value** | Will automatically pull from the linked order. |  | **Required** |
| **lineItemId** | **ShipmentLines.ExtendedAttribute[Name="GoogleLineItemId"].value** | Will automatically pull from the linked order. |  | **Required** |
| **quantity** | **ShipmentLines.ShipmentInfos.Qty** | Quantity Shipped |  | **Required** |
| **trackingId** | **ShipmentLines.ShipmentInfos.TrackingNumber** | Tracking Number for each container |  | **Required** |
| **carrier** | **ShipmentLines.ShipmentInfos.ClassCode** | ReceiverClassCode will be used if mapped to the Logicbroker standard shipping codes. | Supported Carrier values include: "ups", "usps", "fedex", "dhl", "ontrac", "dhl express", "deliv", "dynamex", "lasership", "mpx", "uds", "efw", "jd logistics", "yunexpress", "china post", "china ems", "singapore post", "pos malaysia", "postnl", "ptt", "eub", "chukou1" | **Required** |
| **shipmentId** | **"asn" + shipment.Identifier.LogicbrokerKey + "-" + index** | Will automatically generate |  | **Required** |
| **operationId** | **"asn" + shipment.Identifier.LogicbrokerKey + "-" + index** | Will automatically generate |  | **Required** |

#### Return Response (From Logicbroker)

*This section is not detailed in the provided text but would typically include fields for refund amount, reason codes, etc.*
```

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

### EDI Order ShipTo Address Example

Source: https://help.logicbroker.com/hc/en-us/articles/360021847952-Order-Specifications

Demonstrates how the ShipTo address CompanyName is represented in the EDI 850 format for Logicbroker orders. The example uses the N1 segment with the ST qualifier.

```edi
N1*ST*Merchant Co~

```

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

### SFTP/FTP Access

Source: https://help.logicbroker.com/hc/en-us/articles/360022067691-AS2-Information-EDI-Only

Details on how to connect to LogicBroker's SFTP/FTP servers for both staging and production environments. Includes hostnames, credentials, and IP address whitelisting information.

```APIDOC
## SFTP/FTP

### Description
This section provides information for EDI users to connect to LogicBroker's SFTP/FTP servers. It outlines the hostnames for both staging and production environments, along with the recommended authentication methods using either user credentials or account credentials.

### Method
N/A (Configuration Information)

### Endpoint
N/A (Configuration Information)

### Parameters
#### Hostnames
- **Stage Host**: vftp-stage.logicbroker.com
- **Production Host**: vftp.logicbroker.com

#### Credentials
Users can authenticate using one of the following methods:
- **User Credentials**: Use the same username and password used to log into the LogicBroker portal.
- **Account Credentials** (Recommended for automated integrations):
    - **Username**: Your LogicBroker Account Number (Found in Settings > Account Information > Account Number).
    - **Password**: Your LogicBroker API key (Found in Settings > API Authentication > Primary Key).

### Notes
- **Recommendation**: For automated integrations, using Account Credentials is recommended to avoid connection issues if portal user passwords are changed.
- **IP Address Whitelisting**: 
    - **Stage IP Address**: 20.231.21.146
    - **Production IP Address**: 20.124.32.239
- **Disclaimer**: LogicBroker does not monitor these IP addresses. Users should be able to look up the vFTP IP address independently if needed.
```

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

### SFTP/FTP Connection Details

Source: https://help.logicbroker.com/hc/en-us/articles/360022067691

Provides connection details for LogicBroker's SFTP/FTP services, including hostnames, credentials, and IP addresses for both staging and production environments.

```APIDOC
## SFTP/FTP

### Description
This section outlines the connection details for accessing LogicBroker's SFTP/FTP services. It covers both staging and production environments, including hostnames, authentication methods, and IP addresses for whitelisting.

### Method
N/A (Information endpoint)

### Endpoint
N/A (Information endpoint)

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (Information)
- **Stage Host** (string) - The hostname for the staging SFTP/FTP server.
- **Production Host** (string) - The hostname for the production SFTP/FTP server.
- **Credentials** (object) - Options for authentication:
  - **User Credentials** (object) - Uses portal login username and password.
  - **Account Credentials** (object) - Recommended for automated integrations. Uses LogicBroker Account Number as username and API Key as password.
- **Stage IP Address** (string) - The IP address for the staging SFTP/FTP server, for whitelisting purposes.
- **Production IP Address** (string) - The IP address for the production SFTP/FTP server, for whitelisting purposes.

#### Response Example
```json
{
  "stage_host": "vftp-stage.logicbroker.com",
  "production_host": "vftp.logicbroker.com",
  "credentials": {
    "user": {
      "description": "Use the same username and password you use to log into the portal."
    },
    "account": {
      "description": "Recommended for automated integrations. Username is your LogicBroker Account Number, and password is your API key."
    }
  },
  "stage_ip_address": "20.231.21.146",
  "production_ip_address": "20.124.32.239"
}
```
```
Tokens:
Raw