Versions Compared

Old Version 14

changes.mady.by.user James Seabrook

Saved on

compared with

New Version Current

changes.mady.by.user James Seabrook

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Introduction

This section is split by service. These are all the services available to connect to on the Integration Hub. A full list of services documented in this section can be found below. Each section provides detailed information on the service, such as available field information and system behaviour details.

...

Call

Cancel the Sales Order with Reason Code (POST)

Note:The GUID generated by the Integration Hub (or provided using the GUID parameter) is used to identify the order.

URL

https://hubuat1.supplystream.com/hub/api/salesorders/v1/<guid>/ cancel/reasoncode/001.json?&token=<token>

Available Reason Codes:

  • 001 - Customer Request

  • 002 - Order Delayed

  • 003 - Duplicate

  • 004 - Item not available

  • 005 - Cannot ship to address

  • 006 - Other

RESULT

 

...

Call

Release the Sales Order from Hold (POST)

URL

https://hubuat1.supplystream.com/hub/api/salesorders/v1/<salesOrderNumbe r>/ releasefromhold.json?&token=<token>

RESULT

 

...

Call

Check the status of an order (GET)

Note:The GUID generated by the Integration Hub (or provided using the GUID parameter) is used to identify the order.

URL

https://hubuat1.supplystream.com/hub/api/salesorders/v1/<guid>/status.js on?&token=<token>

RESULT

<Response>

  <CallStatus>

    <Success>true</Success>

    <Code>0</Code>

    <Message/>

  </CallStatus>

  <Status>To Be Picked</Status>

  <GUID>f269cbf9-b2c8-4b6c-85e4-1e21eb833a47</GUID> </Response>

The available statuses are:

  • To Be Picked

  • Being Picked

  • Pick Complete

  • To Dispatch

  • Dispatched

  • Cancelled

...

Call

Check the tracking status of an order (GET)

Note:The GUID generated by the Integration Hub (or provided using the GUID parameter) is used to identify the order.

URL

https://hubuat1.supplystream.com/hub/api/salesorders/v1/<guid>/tracking.

json?&token=<token>

RESULT

{"Response": {

    "CallStatus": {

        "Code": 0,

        "Message": {},

        "Success": true

    },

    "Courier": "DHL",

    "GUID": "468DF821564618DD7113734544443021",

    "TrackingNumber": "12345699000838L" }}

...

Call

Retrieve details of a Dispatched Sales Order (GET)

Note:The GUID generated by the Integration Hub (or provided using the GUID parameter) is used to identify the order.

URL

https://hubuat1.supplystream.com/hub/api/dispatches/v1/<guid>.json?&toke n=<token>

RESULT

{"Response": {

    "BeingPickedDate": "2013-07-10T12:44:26+01:00",

    "CallStatus": {

        "Code": 0,

        "Message": {},

        "Success": true

    },

    "CourierName": "DPD",

    "CourierRef": "15501999000838L",

    "CurrentStatus": "Dispatched",

    "DispatchDate": "2013-07-10T13:07:18+01:00",

    "GUID": "468DF821564618DD7113734544443021",

    "List": {"DispatchLineItem": {

        "DispatchQuantity": 1,

        "GUID": "468DF821564618DD7113734544443022",

        "LineItemNumber": 1

    }},

    "ToBePackedDate": "2013-07-10T12:45:27+01:00",

    "ToDispatchDate": "2013-07-10T12:56:00+01:00"

}}

...