Custom Gateway - Customer Support


Welcome to the Custom Gateway Support Portal

Here you can raise support tickets and read articles on common queries using the topic sections and search below

Integrating With OneFlow

Follow

Introduction

OMS has the ability to send orders into a OneFlow account and subsequently receive status updates for those orders.

Configuration

Supplier Link Settings

Name Description
API Key       An API key provided by OneFlow
API Secret An API secret provided by OneFlow
Destination Account 

Account code provided by OneFlow

(typically this is the name of the supplier)

Override Component Code Each OneFlow product has the concept of one or more components. By default OMS will use the manufacturers code from the eCommerce section, however this can be overridden in the GUID.

Callback URLs

NOTE: ORDERS WITH SECONDARY COMPANIES CAN ONLY BE UPDATED WITH A CALLBACK USING THE SECONDARY COMPANY GUID

From within the OneFlow system, callback URLs can be set for various events.

The structure of the callback URL should be as follows:

https://legacy.custom-gateway.net/acp/api/sl/oneflow/?g=COMPANYREFID&k=APIKEY

Where COMPANYREFID and APIKEY are substituted for their respective values.

OneFlow also needs to be told what data to include within the callback. The following templates should be used:

Order Errored

{

"TimeStamp": "{{timestamp}}",

"SourceOrderId": "{{data.orderData.sourceOrderId}}",

"OrderStatus": "error"

}

Order Shipped

{

"TimeStamp": "{{timestamp}}",

"SourceOrderId": "{{data.sourceOrderId}}",

"SourceShipmentId": "{{data.sourceShipmentId}}",

"ShipmentIndex": "{{data.shipmentIndex}}",

"TrackingNumber": "{{data.trackingNumber}}",

"OrderStatus": "shipped"

}

Order Cancelled

{

"TimeStamp": "{{timestamp}}",

"SourceOrderId": "{{data.orderData.sourceOrderId}}",

"OrderStatus": "cancelled"

}

Print Ready

{

"TimeStamp": "{{timestamp}}",

"SourceOrderId": "{{data.orderData.sourceOrderId}}",

"OrderStatus": "printready"

}

Order Received

{

"TimeStamp": "{{timestamp}}",

"SourceOrderId": "{{data.orderData.sourceOrderId}}",

"OrderStatus": "received"

}

Was this article helpful?
0 out of 0 found this helpful

Comments