API docs by Redocly

THG Fulfil (1)

Download OpenAPI specification:Download

THG Fulfil

inventory item

Get approval status

Authorizations:
BearerAuth
path Parameters
owner
required
string
inventory_item
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Available statuses for approval status

Authorizations:
BearerAuth
path Parameters
owner
required
string
inventory_item
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Get all inventory item

Authorizations:
BearerAuth
path Parameters
owner
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": [
    ],
  • "links": {
    }
}

Create inventory item

Authorizations:
BearerAuth
path Parameters
owner
required
string
Request Body schema: application/json
required
Consumerreference (string) or Consumerreference (null) (Consumerreference)

SKU for the inventory item

title
required
string (Title)

name of inventory item

Defaultcountryoforigin (string) or Defaultcountryoforigin (null) (Defaultcountryoforigin)

Origin country for the inventory item in ISO 3166-1 (Alpha 2)

Harmonizedsystemcode (string) or Harmonizedsystemcode (null) (Harmonizedsystemcode)

A code for international trade. This must be string of digits of length 12. trade.gov - hsCodes

Hazmatcode (string) or Hazmatcode (null) (Hazmatcode)

The UN Number for identifying hazardous material

required
Array of objects (Barcodes)

The barcodes that can be physically attached to the item

required
object (Dimensions)

The dimensions of the item in supply chain. i.e. Boxed dimensions

batchControlled
required
boolean (Batchcontrolled)

Boolean Flag to denote if a product is batch controlled or not

description
required
string (Description)

A textual description of the inventory item

type
required
string (Type)

The type or category of the inventory item

Serialnumbercontrolled (boolean) or Serialnumbercontrolled (null) (Serialnumbercontrolled)
Default: false

Specifies whether the serial number needs to be recorded for this item

Responses

Request samples

Content type
application/json
{
  • "consumerReference": "12345",
  • "title": "cd",
  • "defaultCountryOfOrigin": "US",
  • "harmonizedSystemCode": "999999999999",
  • "hazmatCode": "3811",
  • "barcodes": {
    },
  • "dimensions": {
    },
  • "batchControlled": true,
  • "description": "string",
  • "type": "string",
  • "serialNumberControlled": true
}

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Get inventory item

Authorizations:
BearerAuth
path Parameters
owner
required
string
inventory_item
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Delete inventory item

Authorizations:
BearerAuth
path Parameters
owner
required
string
inventory_item
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

pre advice

Get pre advice approval

Authorizations:
BearerAuth
path Parameters
owner
required
string
pre_advice
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Available statuses for pre advice approval

Authorizations:
BearerAuth
path Parameters
owner
required
string
pre_advice
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Get all pre advice

Authorizations:
BearerAuth
path Parameters
owner
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": [
    ],
  • "links": {
    }
}

Create pre advice

Authorizations:
BearerAuth
path Parameters
owner
required
string
Request Body schema: application/json
required
Consumerreference (string) or Consumerreference (null) (Consumerreference)
required
object (PreAdviceDelivery)
required
Array of objects (Inventoryitems)

Responses

Request samples

Content type
application/json
{
  • "consumerReference": "string",
  • "delivery": {
    },
  • "inventoryItems": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Get pre advice

Authorizations:
BearerAuth
path Parameters
owner
required
string
pre_advice
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Delete pre advice

Authorizations:
BearerAuth
path Parameters
owner
required
string
pre_advice
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

asn

Get progress

Authorizations:
BearerAuth
path Parameters
owner
required
string
asn
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Available statuses for progress

Authorizations:
BearerAuth
path Parameters
owner
required
string
asn
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Get approval

Authorizations:
BearerAuth
path Parameters
owner
required
string
asn
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Available statuses for approval

Authorizations:
BearerAuth
path Parameters
owner
required
string
asn
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Get grn

Authorizations:
BearerAuth
path Parameters
owner
required
string
asn
required
string
grn
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Get all grn

Authorizations:
BearerAuth
path Parameters
owner
required
string
asn
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": [
    ],
  • "links": {
    }
}

Get all asn

Authorizations:
BearerAuth
path Parameters
owner
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": [
    ],
  • "links": {
    }
}

Create asn

Authorizations:
BearerAuth
path Parameters
owner
required
string
Request Body schema: application/json
required
consumerReference
required
string (Consumerreference)
deliveryReference
required
string (Deliveryreference)

From the pre-advice acknowledge

deliveryPartnersReference
required
string (Deliverypartnersreference)

The courier or transporters reference

required
Array of objects (Contents)
required
object (DeliveryVehicle)

Responses

Request samples

Content type
application/json
{
  • "consumerReference": "string",
  • "deliveryReference": "string",
  • "deliveryPartnersReference": "string",
  • "contents": [
    ],
  • "deliveryVehicle": {
    }
}

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Get asn

Authorizations:
BearerAuth
path Parameters
owner
required
string
asn
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Delete asn

Authorizations:
BearerAuth
path Parameters
owner
required
string
asn
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

stock movement

Get stock movement

Authorizations:
BearerAuth
path Parameters
owner
required
string
stock_movement
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Get all stock movement

Authorizations:
BearerAuth
path Parameters
owner
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": [
    ],
  • "links": {
    }
}

stock adjustment

Get stock adjustment

Authorizations:
BearerAuth
path Parameters
owner
required
string
stock_adjustment
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Get all stock adjustment

Authorizations:
BearerAuth
path Parameters
owner
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": [
    ],
  • "links": {
    }
}

shipment

Get approval status

Authorizations:
BearerAuth
path Parameters
owner
required
string
shipment
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Available statuses for approval status

Authorizations:
BearerAuth
path Parameters
owner
required
string
shipment
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Get progress status

Authorizations:
BearerAuth
path Parameters
owner
required
string
shipment
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Available statuses for progress status

Authorizations:
BearerAuth
path Parameters
owner
required
string
shipment
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Get shipment complete

Authorizations:
BearerAuth
path Parameters
owner
required
string
shipment
required
string
shipment_complete
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Get all shipment complete

Authorizations:
BearerAuth
path Parameters
owner
required
string
shipment
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": [
    ],
  • "links": {
    }
}

Get courier allocation

Authorizations:
BearerAuth
path Parameters
owner
required
string
shipment
required
string
courier_allocation
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Get all courier allocation

Authorizations:
BearerAuth
path Parameters
owner
required
string
shipment
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": [
    ],
  • "links": {
    }
}

Get tracking

Authorizations:
BearerAuth
path Parameters
owner
required
string
shipment
required
string
tracking
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Get all tracking

Authorizations:
BearerAuth
path Parameters
owner
required
string
shipment
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": [
    ],
  • "links": {
    }
}

Get return shipment receipt

Authorizations:
BearerAuth
path Parameters
owner
required
string
shipment
required
string
return_shipment_receipt
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Get all return shipment receipt

Authorizations:
BearerAuth
path Parameters
owner
required
string
shipment
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": [
    ],
  • "links": {
    }
}

Get all shipment

Authorizations:
BearerAuth
path Parameters
owner
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": [
    ],
  • "links": {
    }
}

Create shipment

Authorizations:
BearerAuth
path Parameters
owner
required
string
Request Body schema: application/json
required
Consumerreference (string) or Consumerreference (null) (Consumerreference)

Consumer's reference for this shipment

required
object (Address)

Delivery address for the shipment

OrderInformation (object) or null

Information related to the order being shipped

required
object (CustomsInformation)

Customs information for the shipment

required
Array of objects (Inventoryitems)

List of items in the shipment

required
object (ShipmentBehaviour)

Behaviour settings for the shipment

ShipmentType (string) or null
Default: "B2C"

Type of the shipment

deliveryType
required
string (DeliveryType)
Enum: "UK_STANDARD" "UK_NEXT_DAY" "INTERNATIONAL_TRACKED" "WORLD_WIDE_EXPRESS" "CLICK_AND_COLLECT_UK_STANDARD" "CLICK_AND_COLLECT_INTERNATIONAL_STANDARD"

Delivery type of the shipment

Responses

Request samples

Content type
application/json
{
  • "consumerReference": "SHIP12345",
  • "deliveryAddress": {
    },
  • "orderInformation": {
    },
  • "customsInformation": {
    },
  • "inventoryItems": [
    ],
  • "shipmentBehaviour": {
    },
  • "shipmentType": "B2C",
  • "deliveryType": "UK_STANDARD"
}

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Get shipment

Authorizations:
BearerAuth
path Parameters
owner
required
string
shipment
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Delete shipment

Authorizations:
BearerAuth
path Parameters
owner
required
string
shipment
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

return shipment

Get approval status

Authorizations:
BearerAuth
path Parameters
owner
required
string
return_shipment
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Available statuses for approval status

Authorizations:
BearerAuth
path Parameters
owner
required
string
return_shipment
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Get progress status

Authorizations:
BearerAuth
path Parameters
owner
required
string
return_shipment
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Available statuses for progress status

Authorizations:
BearerAuth
path Parameters
owner
required
string
return_shipment
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Get return shipment receipt

Authorizations:
BearerAuth
path Parameters
owner
required
string
return_shipment
required
string
return_shipment_receipt
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Get all return shipment receipt

Authorizations:
BearerAuth
path Parameters
owner
required
string
return_shipment
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": [
    ],
  • "links": {
    }
}

Get all return shipment

Authorizations:
BearerAuth
path Parameters
owner
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": [
    ],
  • "links": {
    }
}

Create return shipment

Authorizations:
BearerAuth
path Parameters
owner
required
string
Request Body schema: application/json
required
Consumerreference (string) or Consumerreference (null) (Consumerreference)

Consumer's reference for this return

returnShippingLabelBarcode
required
string (Returnshippinglabelbarcode) <= 36 characters

The unique identifier encoded as barcode on the outside of the parcel

required
Array of objects (Returnitems)

The list of items being returned

Responses

Request samples

Content type
application/json
{
  • "consumerReference": "20410467",
  • "returnShippingLabelBarcode": "RS123",
  • "returnItems": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Get return shipment

Authorizations:
BearerAuth
path Parameters
owner
required
string
return_shipment
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}

Delete return shipment

Authorizations:
BearerAuth
path Parameters
owner
required
string
return_shipment
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "data": {
    },
  • "links": {
    }
}