Download OpenAPI specification:Download
Welcome to the myHillebrandGori API Developer Portal.
This documentation was last uploaded on 2024-03-14 07:43
We invite you to innovate with our APIs. Join the moment and let's change logistics together.
We understand what you need to bring value to your users. Clear documentation and access to real data for testing purposes.
We are focused on building the best APIs. We'll look after the complexities of logistic processes, so you can focus on creating remarkable user experiences.
The APIs can be called up to 100 times per minute.
To get started with our APIs you have to follow 3 mandatory steps which are described below:
To use our APIs, you need to have both a myHillebrandGori user account aswell as an API key.
If you do not have a myHillebrandGori user account yet, you can get one here: https://my.hillebrandgori.com/signup
The user account is used to obtain access to the data that is relevant for you.
To obtain the API key for your application, sign up here: https://developer.hillebrandgori.com/Register
The API key is necessary for your application to be able to call our APIs.
Note that we need to authorise your request first, which is a manual process.
After receiving the confirmation email that your account has been approved, follow the instructions in this email to activate your account. After these steps you will be able to login to our dev portal.
This email will also contain your API key.
To obtain a token that is needed later in every API call, you need to exchange your user credentials and API key for a token.
Do a http post to https://login.hillebrand.com/oauth2/aus95hq7r8iIqp14M0i7/v1/token.
Provide your API key and secret in the basic authorisation header (separated by a colon and base64 encode it).
Set Content-Type to application/x-www-form-urlencoded
and Accept to application/json
.
In the body provide the following: grant_type=password&username=[username]&password=[password]&scope=offline_access
The response will contain your access token and a refresh token. Store them securely in private, non user accessible storage.
Example request:
POST https://login.hillebrand.com/oauth2/aus95hq7r8iIqp14M0i7/v1/token
Content-Type: application/x-www-form-urlencoded
Accept: application/json
Authorization: Basic YXBpa2V5OmFwaXNlY3JldA==
grant_type=password&username=EnterUserNameHere&password=EnterPasswordHere&scope=offline_access
Use the provided access token in every API call in the authorisation header, prefix it with 'Bearer '. Example request
GET https://api.hillebrandgori.com/v4/shipments
Accept: application/json
Authorization: Bearer eyJraWQiOiIxIiwiYWxnIjoiSFMyNTYifQ.eyJzYW1wbGUiOiJqd3QifQ.1m34VpI4w-rYut4F6VruoMyI95i4nOgED9iY6hDLytI
The access token will expire after a certain period, if this happens you have to request a new access token, using your refresh token.
Do a http post to https://login.hillebrand.com/oauth2/aus95hq7r8iIqp14M0i7/v1/token.
Provide your API key and secret in the basic authorisation header (separated by a colon and base64 encode it).
Set Content-Type to application/x-www-form-urlencoded
and Accept to application/json
.
In the body provide the following: grant_type=refresh_token&refresh_token=[refresh token]&scope=offline_access
The response will contain your new access token and new refresh token.
Use these tokens for your next requests.
Example request:
POST https://login.hillebrand.com/oauth2/aus95hq7r8iIqp14M0i7/v1/token
Content-Type: application/x-www-form-urlencoded
Accept: application/json
Authorization: Basic YXBpa2V5OmFwaXNlY3JldA==
grant_type=refresh_token&refresh_token=PIr11vkIjOIX0b8asESirqGvx0nV12FG&scope=offline_access
Note that you could also do step 2 instead of this step to get a new access token. Using step 4 is more secure though.
Via our webhook mechanism HillebrandGori offers a pro-active update mechanism for our customers. You can create a subscription for one or more event-types and we will notify you when the event(s) occur without the need to regularly poll for updates. Json content will be posted to a URI which you can provide when subscribing to an event-type.
For example, you want to receive a notifications when shipments are ready for transport. Via the 'Shipment ready for transport (new)' event-type subscription you will receive a notification when a shipment becomes ready.
HillebrandGori expects to receive an HTTP 200-OK response code from your endpoint. If we do not receive one we will try to post the webhook again. Our suggestion to prevent time-outs is to send the HTTP 202-Accepted response before doing any processing on the data.
Events are split into two types
The full list of events we currently support is shown below:
Ship from location | |
---|---|
shprdy | Shipment ready for transport (new) |
shprdychg | Shipment ready for transport (changed) |
shpsupdeppln | Planned Departure ship from location (new) |
shpsupdepplnchg | Planned Departure ship from location (changed) |
shpsupdepcnf | Confirmed Departure ship from location (new) |
shpsupdepcnfchg | Confirmed Departure ship from location (changed) |
Consolidation warehouse | |
---|---|
shpexharrpln | Planned arrival consolidation warehouse location (new) |
shpexharrplnchg | Planned arrival consolidation warehouse location (changed) |
shpexharrcnf | Confirmed arrival consolidation warehouse location (new) |
shpexharrcnfchg | Confirmed arrival consolidation warehouse location (changed) |
sphexhdeppln | Planned departure consolidation warehouse location (new) |
sphexhdepplnchg | Planned departure consolidation warehouse location (changed) |
shpexhdepcnf | Confirmed departure consolidation warehouse location (new) |
shpexhdepcnfchg | Confirmed departure consolidation warehouse location (changed) |
Port of loading | |
---|---|
shppolarrcnf | Confirmed arrival Port of loading (new) |
shppolarrcnfchg | Confirmed arrival Port of loading (changed) |
shpprtdeppln | Planned Departure port of loading (new) |
shpprtdepplnchg | Planned Departure port of loading (changed) |
shpprtdepcnf | Confirmed Departure port of loading (new) |
shpprtdepcnfchg | Confirmed Departure port of loading (changed) |
shpairdeppln | Planned departure airplane from airport of departure (new) |
shpairdepplnchg | Planned departure airplane from airport of departure (changed) |
shpairdepcnf | Confirmed departure airplane from airport of departure (new) |
shpairdepcnfchg | Confirmed departure airplane from airport of departure (changed) |
Port of transshipment | |
---|---|
shppoxarrpln | Planned arrival Port of transshipment (new) |
shppoxarrplnchg | Planned arrival Port of transshipment (changed) |
shppoxarrcnf | Confirmed arrival Port of transshipment (new) |
shppoxarrcnfchg | Confirmed arrival Port of transshipment (changed) |
shppoxdeppln | Planned departure Port of transshipment (new) |
shppoxdepplnchg | Planned departure Port of transshipment (changed) |
shppoxdepcnf | Confirmed departure Port of transshipment (new) |
shppoxdepcnfchg | Confirmed departure Port of transshipment (changed) |
Port of arrival | |
---|---|
shpprtarrpln | Planned Arrival port of discharge (new) |
shpprtarrplnchg | Planned Arrival port of discharge (changed) |
shpprtarrcnf | Confirmed Arrival port of discharge (new) |
shpprtarrcnfchg | Confirmed Arrival port of discharge (changed) |
shppoddepcnf | Confirmed departure Port of discharge (new) |
shppoddepcnfchg | Confirmed departure Port of discharge (changed) |
shpairarrpln | Planned arrival airplane to airport of destination (new) |
shpairarrplnchg | Planned arrival airplane to airport of destination (changed) |
shpairarrcnf | Confirmed arrival airplane to airport of destination (new) |
shpairarrcnfchg | Confirmed arrival airplane to airport of destination (changed) |
shpimpcsmclr | Import customs cleared (new) |
shpimpcsmclrchg | Import customs cleared (changed) |
Deconsolidation warehouse | |
---|---|
shpimharrpln | Planned arrival deconsolidation warehouse location (new) |
shpimharrplnchg | Planned arrival deconsolidation warehouse location (changed) |
shpimharrcnf | Confirmed arrival deconsolidation warehouse location (new) |
shpimharrcnfchg | Confirmed arrival deconsolidation warehouse location (changed) |
sphimhdeppln | Planned departure deconsolidation warehouse location (new) |
sphimhdepplnchg | Planned departure deconsolidation warehouse location (changed) |
shpimhdepcnf | Confirmed departure deconsolidation warehouse location (new) |
shpimhdepcnfchg | Confirmed departure deconsolidation warehouse location (changed) |
Ship to location | |
---|---|
shpcusarrpln | Planned Arrival ship to location (new) |
shpcusarrplnchg | Planned Arrival ship to location (changed) |
shpcusarrcnf | Confirmed Arrival ship to location (new) |
shpcusarrcnfchg | Confirmed Arrival ship to location (changed) |
Returns the list of shipments that match the specified search parameters. To limit the number of requests on this API we advice you to make use of the modifiedSinceTimeStamp queryparameter. With this parameter you can search for Shipments which have been updated since that DateTime.
references | Array of strings Search for 1 or multiple reference(s) equal to criteria. References can be customer references, container numbers and B/L references as well. |
fromCountries | Array of strings Search for FromCountry (or Countries) equal to criteria. Searchaction based on countrycode(s). eg 'NL'. |
toCountries | Array of strings Search for ToCountry (or Countries) equal to criteria. Searchaction based on countrycode(s). eg 'NL'. |
shipDateFrom | string <date> Search for Shipments with a departureDate equal to or later than criterium. |
shipDateTo | string <date> Search for Shipments with a departureDate equal to or earlier than criterium. |
arrivalDateFrom | string <date> Search for Shipments with an arrivalDate equal to or later than criterium. |
arrivalDateTo | string <date> Search for Shipments with an arrivalDate equal to or earlier than criterium. |
status | Array of strings or null (shipmentStatusEnum) Items Enum: "notReady" "ready" "collected" "loaded" "shipped" "arrived" "unloaded" "delivered" Search for 1 or multiple status(es) equal to criteria (Not ready, Ready Shipped, Arrived, Delivered). |
includeInactiveShipments | boolean Default: false true = resultset with inactive Shipments, false = result without inactive Shipments IF shipmentStatus = (Arrived OR Delivered) AND latest date more than 1 month ago OR latest date 3 months ago THEN The shipment will be marked as Inactive |
onTimeStatus | string (OnTimeStatusEnum) Enum: "onTime" "late" Search for ontimestatus equal to criteria (Ontime, Late). |
favourite | boolean Search for 1 or multiple favourite(s) equal to criteria. |
units | string (UnitsEnum) Enum: "metric" "imperial" "imperialUk" Units in Metric, Imperial UK or Imperial US. If empty, it will be defaulted to metric. |
modifiedSinceTimeStamp | integer Example: modifiedSinceTimeStamp=1642581566 Search for Shipments which have been changed since this timestamp. The timestamp is the Unix Timestamp, i.e. the number of seconds since Epoch (1/1/1970). |
sortBy | Array of strings (ShipmentsSortByEnum) Items Enum: "default" "actualDepartureDate_ascending" "actualDepartureDate_descending" "actualArrivalDate_ascending" "actualArrivalDate_descending" "estimatedDepartureDate_ascending" "estimatedDepartureDate_descending" "estimatedArrivalDate_ascending" "estimatedArrivalDate_descending" "departureDate_ascending" "departureDate_descending" "arrivalDate_ascending" "arrivalDate_descending" "equipmentNumber_ascending" "equipmentNumber_descending" "shipmentReference_ascending" "shipmentReference_descending" "favourite_ascending" "favourite_descending" Fieldnames and their order to sort on, parameter can be (re)used or chained multiple times. |
entityType | string (EntityTypeEnum) Enum: "shipment" "invoice" "quote" "container" "party" "product" Filter on entitytype that the Task relates to. |
entityId | integer <int64> Filter on Id of the Entity. |
pageNumber | integer <int32> Default: 1 Page number. |
pageSize | integer <int32> Default: 10 Page size |
curl GET 'https://api.hillebrandgori.com/v5/shipments' --header 'Accept: application/json' --header 'Authorization: Bearer <your-token>'
{- "_pagingInfo": {
- "totalItems": 0,
- "totalPages": 0,
- "hasPreviousPage": true,
- "hasNextPage": true,
- "itemsOnPage": 0,
- "pageNumber": 0,
- "pageSize": 0
}, - "items": [
- {
- "_links": {
- "href": "string",
- "rel": "self",
- "modifiedTimeStamp": 1580981375
}, - "id": 46897,
- "modifiedTimeStamp": 1580981375,
- "shipFromPartyName": "ABCwinery",
- "shipFromLocation": {
- "cityName": "Rotterdam",
- "cityCode": "NLRTM",
- "countryName": "Netherlands",
- "countryCode": "NL",
- "countrySubEntityName": "Zuid Holland",
- "countrySubEntityCode": "ZH"
}, - "shipFromLocationStatus": null,
- "estimatedDepartureDate": "2018-01-28T08:00:00",
- "actualDepartureDate": "2018-01-28T09:00:00",
- "departureDate": "2018-01-28T09:00:00",
- "shipToPartyName": "ABCsupermarket",
- "shipToLocation": {
- "cityName": "Rotterdam",
- "cityCode": "NLRTM",
- "countryName": "Netherlands",
- "countryCode": "NL",
- "countrySubEntityName": "Zuid Holland",
- "countrySubEntityCode": "ZH"
}, - "shipToLocationStatus": null,
- "estimatedArrivalDate": "2018-02-28T08:00:00",
- "actualArrivalDate": "2018-02-28T07:00:00",
- "arrivalDate": "2018-01-28T09:00:00",
- "soldBy": "ABCwinery",
- "soldTo": "ABCsupermarket",
- "lastEvent": {
- "_links": {
- "href": "string",
- "rel": "self",
- "modifiedTimeStamp": 1580981375
}, - "id": 46897,
- "code": "shpcusarrcnf",
- "category": "exception",
- "date": "2018-01-28T09:00:00",
- "lastUpdate": 1527240228,
- "text": "Shipment FR99021 has departed from Singapore on 2018-05-22",
- "template": "Shipment {{shipment}} has departed from {{shipFromLocation}} on {{shipFromDate}}",
- "templateVariables": [
- {
- "name": "shipFromDate",
- "value": "2018-05-22",
- "dataType": "string",
- "dataTypeFormat": "date",
- "resource": {
- "_links": {
- "href": "string",
- "rel": "self",
- "modifiedTimeStamp": 1580981375
}, - "id": 2387423,
- "type": "shipment"
}, - "primary": false
}
]
}, - "status": "notReady",
- "references": [
- {
- "reference": "ABC3456789",
- "role": "agent"
}
], - "equipment": {
- "number": "ABCD1234567",
- "classification": "container",
- "type": "20ā",
- "refrigerationOperational": true,
- "reeferTemperature": 10,
- "reeferTemperatureUnit": "cel",
- "fittings": [
- "insulation"
], - "transportReferences": [
- {
- "description": "Datalogger",
- "number": "DTL01234567"
}
], - "grossWeight": 18567,
- "grossWeightUnit": "kgm",
- "sealNumbers": [
- "123456ABC"
]
}, - "progress": 50,
- "onTimeStatus": "onTime",
- "emission": {
- "calculation": "notAvailable",
- "unit": "tne",
- "type": "notAvailable",
- "value": 0
}, - "favourite": {
- "_links": {
- "href": "string",
- "rel": "self",
- "modifiedTimeStamp": 1580981375
}, - "favourite": true
}, - "readyDate": "2019-08-24T14:15:22Z",
- "mainModality": "unknown"
}
]
}
Returns information for a specific shipment.
id required | integer <int64> Shipment Id |
units | string (UnitsEnum) Enum: "metric" "imperial" "imperialUk" Units in Metric, Imperial UK or Imperial US. If empty, it will be defaulted to metric. |
curl GET 'https://api.hillebrandgori.com/v5/shipments/{id}' --header 'Accept: application/json' --header 'Authorization: Bearer <your-token>'
{- "id": 46897,
- "modifiedTimeStamp": 1580981375,
- "status": "notReady",
- "shipFromPartyName": "ABCwinery",
- "shipFromLocation": {
- "cityName": "Rotterdam",
- "cityCode": "NLRTM",
- "countryName": "Netherlands",
- "countryCode": "NL",
- "countrySubEntityName": "Zuid Holland",
- "countrySubEntityCode": "ZH"
}, - "shipFromLocationStatus": null,
- "estimatedDepartureDate": "2018-01-28T08:00:00",
- "actualDepartureDate": "2018-01-28T09:00:00",
- "departureDate": "2018-01-28T09:00:00",
- "shipToPartyName": "ABCsupermarket",
- "shipToLocation": {
- "cityName": "Rotterdam",
- "cityCode": "NLRTM",
- "countryName": "Netherlands",
- "countryCode": "NL",
- "countrySubEntityName": "Zuid Holland",
- "countrySubEntityCode": "ZH"
}, - "shipToLocationStatus": null,
- "estimatedArrivalDate": "2018-02-28T08:00:00",
- "actualArrivalDate": "2018-02-28T07:00:00",
- "arrivalDate": "2018-01-28T09:00:00",
- "soldBy": "ABCwinery",
- "soldTo": "ABCsupermarket",
- "references": [
- {
- "reference": "ABC3456789",
- "role": "agent"
}
], - "otherReferences": [
- "PROMO-346273687"
], - "equipment": {
- "number": "ABCD1234567",
- "classification": "container",
- "type": "20ā",
- "refrigerationOperational": true,
- "reeferTemperature": 10,
- "reeferTemperatureUnit": "cel",
- "fittings": [
- "insulation"
], - "transportReferences": [
- {
- "description": "Datalogger",
- "number": "DTL01234567"
}
], - "grossWeight": 18567,
- "grossWeightUnit": "kgm",
- "sealNumbers": [
- "123456ABC"
]
}, - "demurrageAndDetention": {
- "type": "demurrageAndDetention",
- "phase": "pendingDischargeFromVessel",
- "freeDaysAtPort": 0,
- "freeDaysOutsidePort": 0,
- "freeDaysAtDestination": 0,
- "lastFreeDayAtPortDate": "2019-08-24T14:15:22Z",
- "emptyReturnCutoffDate": "2019-08-24T14:15:22Z",
- "emptyGatedInDate": "2019-08-24T14:15:22Z",
- "fullGatedOutDate": "2019-08-24T14:15:22Z"
}, - "progress": 50,
- "totalPackages": 1340,
- "palletisation": "22 pallets",
- "grossWeight": 18567,
- "grossWeightUnit": "kgm",
- "lastEvent": {
- "_links": {
- "href": "string",
- "rel": "self",
- "modifiedTimeStamp": 1580981375
}, - "id": 46897,
- "code": "shpcusarrcnf",
- "category": "exception",
- "date": "2018-01-28T09:00:00",
- "lastUpdate": 1527240228,
- "text": "Shipment FR99021 has departed from Singapore on 2018-05-22",
- "template": "Shipment {{shipment}} has departed from {{shipFromLocation}} on {{shipFromDate}}",
- "templateVariables": [
- {
- "name": "shipFromDate",
- "value": "2018-05-22",
- "dataType": "string",
- "dataTypeFormat": "date",
- "resource": {
- "_links": {
- "href": "string",
- "rel": "self",
- "modifiedTimeStamp": 1580981375
}, - "id": 2387423,
- "type": "shipment"
}, - "primary": false
}
]
}, - "hsCodes": [
- 220410
], - "onTimeStatus": "onTime",
- "emission": {
- "calculation": "notAvailable",
- "unit": "tne",
- "type": "notAvailable",
- "value": 0
}, - "favourite": {
- "_links": {
- "href": "string",
- "rel": "self",
- "modifiedTimeStamp": 1580981375
}, - "favourite": true
}, - "incoterm": {
- "incoterm": "exw",
- "locationCode": "TRKMX",
- "locationName": "Kumport"
}, - "commodity": "wines",
- "readyDate": "2019-08-24T14:15:22Z",
- "insured": true,
- "mainModality": "unknown",
- "booking": {
- "number": "34766DF23",
- "dateTime": "2020-11-11T09:13:00",
- "billOfLadingNumbers": [
- {
- "number": "MLU28934SD737",
- "type": "master"
}
], - "carrier": {
- "name": "Maersk Line",
- "scac": "MAEU"
}, - "shippingLine": {
- "name": "Maersk Line",
- "scac": "MAEU"
}
}
}
Returns the list of contacts for a shipment that match the specified search parameters.
id required | integer <int64> Shipment Id |
role | string (shipmentRoleEnum) Enum: "agent" "carrier" "soldTo" "shipFrom" "notifyParty" "otherParty" "serviceProvider" "soldBy" "shipTo" "serviceCustomer" Search for 1 or more parties where the role equal to criteria (Agent, Carrier, Sold to, Ship from, Notify Party, Other Party, Service Provider, Sold by, Ship to or Service Customer). |
userActsFor | boolean Search for the Party where I act for |
pageNumber | integer <int32> Default: 1 Page number. |
pageSize | integer <int32> Default: 10 Page size |
curl GET 'https://api.hillebrandgori.com/v5/shipments/{id}/contacts' --header 'Accept: application/json' --header 'Authorization: Bearer <your-token>'
{- "_pagingInfo": {
- "totalItems": 0,
- "totalPages": 0,
- "hasPreviousPage": true,
- "hasNextPage": true,
- "itemsOnPage": 0,
- "pageNumber": 0,
- "pageSize": 0
}, - "items": [
- {
- "_links": {
- "href": "string",
- "rel": "self",
- "modifiedTimeStamp": 1580981375
}, - "id": "se4568",
- "party": {
- "_links": {
- "href": "string",
- "rel": "self",
- "modifiedTimeStamp": 1580981375
}, - "id": 4568,
- "name": "ABCParty"
}, - "name": "A.B. Name",
- "reference": "PO142452",
- "role": "agent",
- "userActsFor": false,
- "emailAddress": "[email protected]"
}
]
}
Returns a list of documents belonging to a specific Shipment.
id required | integer <int64> Shipment Id |
pageNumber | integer <int32> Default: 1 Page number. |
pageSize | integer <int32> Default: 10 Page size |
latestVersionOnly | Array of strings (shipmentDocumentCodeEnum) Items Enum: "cbl" "cdo" "cin" "hbl" "inc" "quo" "pli" "lol" "rdr" "lcr" "ddo" "por" "dcd" "pod" "pic" "sin" "cer" "loc" "wce" "pin" "pla" "isf" |
sortBy | Array of strings (DocumentsSortByEnum) Items Enum: "default" "documentTypeCode_ascending" "documentTypeCode_descending" "user_ascending" "user_descending" "creationDate_ascending" "creationDate_descending" "fileName_ascending" "fileName_descending" Fieldnames and their order to sort on, parameter can be (re)used or chained multiple times. |
curl GET 'https://api.hillebrandgori.com/v5/shipments/{id}/documents' --header 'Accept: application/json' --header 'Authorization: Bearer <your-token>'
{- "_pagingInfo": {
- "totalItems": 0,
- "totalPages": 0,
- "hasPreviousPage": true,
- "hasNextPage": true,
- "itemsOnPage": 0,
- "pageNumber": 0,
- "pageSize": 0
}, - "items": [
- {
- "_links": {
- "href": "string",
- "rel": "self",
- "modifiedTimeStamp": 1580981375
}, - "ticket": "House BLĀ¤-5176fede-e076-4ea1-9658-7efbc464c841.pdf",
- "documentType": {
- "code": "cbl",
- "description": "Carrier Bill of lading"
}, - "documentDateTime": "2018-01-28T09:00:00",
- "fileName": "Invoice-123456_Hillebrand.pdf",
- "fileExtension": "pdf",
- "references": [
- {
- "referenceType": "File",
- "referenceValue": "SET-US-1808-7116"
}
], - "sharedParties": [
- {
- "_links": {
- "href": "string",
- "rel": "self",
- "modifiedTimeStamp": 1580981375
}, - "id": 12,
- "name": "ABCParty"
}
], - "comment": "string"
}
]
}
Creates the metadata of 1 new document for 1 shipment
id required | integer <int64> Shipment Id |
object (shipmentDocumentTypeInfo) | |
documentDateTime | string <date-time> The date/time of the document. May not be in the future and not older than 1 year. Optional value. |
fileName | string The file name |
Array of objects (shipmentReferences) | |
user | string The user who stored the document |
Array of objects (SharedParty) All Parties who are allowed to see the Document. | |
comment | string <= 255 characters An additional explanation about the Document. |
{- "documentType": {
- "code": "cbl",
- "description": "Carrier Bill of lading"
}, - "documentDateTime": "2018-01-28T09:00:00",
- "fileName": "Invoice-123456_Hillebrand.pdf",
- "references": [
- {
- "referenceType": "File",
- "referenceValue": "SET-US-1808-7116"
}
], - "sharedParties": [
- {
- "id": 12
}
], - "comment": "string"
}
{- "href": "string",
- "rel": "self",
- "id": "string",
- "type": "string"
}
Returns the content of 1 new document for 1 shipment
id required | integer <int64> Shipment Id |
ticket required | string |
curl GET 'https://api.hillebrandgori.com/v5/shipments/{id}/documents/{ticket}/content' --header 'Accept: application/json' --header 'Authorization: Bearer <your-token>'
{- "statusCode": 400,
- "error": "badRequest",
- "message": "The value 'a' is not valid for PageSize."
}
Creates the content of 1 new document for 1 shipment
id required | integer <int64> Shipment Id |
ticket required | string |
A document
{- "statusCode": 400,
- "error": "badRequest",
- "message": "The value 'a' is not valid for PageSize."
}
Returns the list relevant Events for a specific shipment.
id required | integer <int64> Shipment Id |
lastUpdateAfter | integer <int64> Return events after specified unix timestamp. |
lastUpdateBefore | integer <int64> Return events before specified unix timestamp. if lastUpdateAfter is also provided this value it ignored. |
includeCodes | Array of strings (CodeEnum) Items Enum: "shpcusarrcnf" "shpcusarrcnfchg" "shpprtarrcnf" "shpprtarrcnfchg" "shpairarrcnf" "shpairarrcnfchg" "shpsupdepcnf" "shpsupdepcnfchg" "shpprtdepcnf" "shpprtdepcnfchg" "shpairdepcnf" "shpairdepcnfchg" "shpcusarrpln" "shpcusarrplnchg" "shpprtarrpln" "shpprtarrplnchg" "shpairarrpln" "shpairarrplnchg" "shpsupdeppln" "shpsupdepplnchg" "shpprtdeppln" "shpprtdepplnchg" "shpairdeppln" "shpairdepplnchg" "shpprtarrplndel" "shpprtarrplnupd" "shpprtarrcnfdel" "shpcusarrplndel" "shpcusarrplnupd" "shpcusarrcnfdel" "shpnewcmt" "docupl" "shprdy" "shprdyrdr" "lngcnf" "lngcnflcr" "shpimpcsmclr" "shpimpcsmclrchg" "shpvslchg" "shpexharrpln" "shpexharrplnchg" "shpexharrcnf" "shpexharrcnfchg" "sphexhdeppln" "sphexhdepplnchg" "shpexhdepcnf" "shpexhdepcnfchg" "shppolarrcnf" "shppolarrcnfchg" "shppoxarrpln" "shppoxarrplnchg" "shppoxarrcnf" "shppoxarrcnfchg" "shppoxdeppln" "shppoxdepplnchg" "shppoxdepcnf" "shppoxdepcnfchg" "shppoddepcnf" "shppoddepcnfchg" "shpimharrpln" "shpimharrplnchg" "shpimharrcnf" "shpimharrcnfchg" "sphimhdeppln" "sphimhdepplnchg" "shpimhdepcnf" "shpimhdepcnfchg" "shprdychg" Include only events with specified code. |
excludeCodes | Array of strings (CodeEnum) Items Enum: "shpcusarrcnf" "shpcusarrcnfchg" "shpprtarrcnf" "shpprtarrcnfchg" "shpairarrcnf" "shpairarrcnfchg" "shpsupdepcnf" "shpsupdepcnfchg" "shpprtdepcnf" "shpprtdepcnfchg" "shpairdepcnf" "shpairdepcnfchg" "shpcusarrpln" "shpcusarrplnchg" "shpprtarrpln" "shpprtarrplnchg" "shpairarrpln" "shpairarrplnchg" "shpsupdeppln" "shpsupdepplnchg" "shpprtdeppln" "shpprtdepplnchg" "shpairdeppln" "shpairdepplnchg" "shpprtarrplndel" "shpprtarrplnupd" "shpprtarrcnfdel" "shpcusarrplndel" "shpcusarrplnupd" "shpcusarrcnfdel" "shpnewcmt" "docupl" "shprdy" "shprdyrdr" "lngcnf" "lngcnflcr" "shpimpcsmclr" "shpimpcsmclrchg" "shpvslchg" "shpexharrpln" "shpexharrplnchg" "shpexharrcnf" "shpexharrcnfchg" "sphexhdeppln" "sphexhdepplnchg" "shpexhdepcnf" "shpexhdepcnfchg" "shppolarrcnf" "shppolarrcnfchg" "shppoxarrpln" "shppoxarrplnchg" "shppoxarrcnf" "shppoxarrcnfchg" "shppoxdeppln" "shppoxdepplnchg" "shppoxdepcnf" "shppoxdepcnfchg" "shppoddepcnf" "shppoddepcnfchg" "shpimharrpln" "shpimharrplnchg" "shpimharrcnf" "shpimharrcnfchg" "sphimhdeppln" "sphimhdepplnchg" "shpimhdepcnf" "shpimhdepcnfchg" "shprdychg" Exclude only events with specified code. if includeCodes is also provided this value it ignored. |
pageNumber | integer <int32> Default: 1 Page number. |
pageSize | integer <int32> Default: 10 Page size |
curl GET 'https://api.hillebrandgori.com/v5/shipments/{id}/events' --header 'Accept: application/json' --header 'Authorization: Bearer <your-token>'
{- "_pagingInfo": {
- "totalItems": 0,
- "totalPages": 0,
- "hasPreviousPage": true,
- "hasNextPage": true,
- "itemsOnPage": 0,
- "pageNumber": 0,
- "pageSize": 0
}, - "items": [
- {
- "_links": {
- "href": "string",
- "rel": "self",
- "modifiedTimeStamp": 1580981375
}, - "id": 46897,
- "code": "shpcusarrcnf",
- "category": "exception",
- "date": "2018-01-28T09:00:00",
- "lastUpdate": 1527240228,
- "text": "Shipment FR99021 has departed from Singapore on 2018-05-22",
- "template": "Shipment {{shipment}} has departed from {{shipFromLocation}} on {{shipFromDate}}",
- "templateVariables": [
- {
- "name": "shipFromDate",
- "value": "2018-05-22",
- "dataType": "string",
- "dataTypeFormat": "date",
- "resource": {
- "_links": {
- "href": "string",
- "rel": "self",
- "modifiedTimeStamp": 1580981375
}, - "id": 2387423,
- "type": "shipment"
}, - "primary": false
}
]
}
]
}
Returns a list of Insurances belonging to a specific Shipment.
id required | integer <int64> Shipment Id |
curl GET 'https://api.hillebrandgori.com/v5/shipments/{id}/insurances' --header 'Accept: application/json' --header 'Authorization: Bearer <your-token>'
{- "items": [
- {
- "id": 46897,
- "startDate": "2018-01-28T09:00:00",
- "description": "Stellenbosch - Cape Town - London Gateway - Northampton",
- "currencyCode": "USD",
- "insuredValue": 31484.61,
- "taxes": 0
}
]
}
Returns the list of transport legs for a specific shipment.
id required | integer <int64> Shipment Id |
units | string (UnitsEnum) Enum: "metric" "imperial" "imperialUk" Units in Metric, Imperial UK or Imperial US. If empty, it will be defaulted to metric. |
fromSequenceNumber | integer <int32> |
toSequenceNumber | integer <int32> |
curl GET 'https://api.hillebrandgori.com/v5/shipments/{id}/legs' --header 'Accept: application/json' --header 'Authorization: Bearer <your-token>'
{- "items": [
- {
- "fromLocation": {
- "_links": {
- "href": "string",
- "rel": "self",
- "modifiedTimeStamp": 1580981375
}, - "sequenceNumber": 3,
- "coordinate": {
- "latitude": 43.3518319,
- "longitude": -3.082039
}, - "address": {
- "cityName": "Rotterdam",
- "cityCode": "NLRTM",
- "countryName": "Netherlands",
- "countryCode": "NL",
- "countrySubEntityName": "Zuid Holland",
- "countrySubEntityCode": "ZH"
}, - "arrivalDate": "2018-01-28T09:00:00",
- "departureDate": "2018-01-28T09:00:00"
}, - "toLocation": {
- "_links": {
- "href": "string",
- "rel": "self",
- "modifiedTimeStamp": 1580981375
}, - "sequenceNumber": 3,
- "coordinate": {
- "latitude": 43.3518319,
- "longitude": -3.082039
}, - "address": {
- "cityName": "Rotterdam",
- "cityCode": "NLRTM",
- "countryName": "Netherlands",
- "countryCode": "NL",
- "countrySubEntityName": "Zuid Holland",
- "countrySubEntityCode": "ZH"
}, - "arrivalDate": "2018-01-28T09:00:00",
- "departureDate": "2018-01-28T09:00:00"
}, - "modality": "unknown",
- "status": null,
- "handledBy": null,
- "vessel": {
- "carrier": "Maersk Line",
- "name": "Vessel123",
- "imo": 9290452,
- "flag": "Netherlands (NL)",
- "voyageNumber": "V.284"
}, - "equipment": {
- "number": "ABCD1234567",
- "classification": "container",
- "type": "20ā",
- "refrigerationOperational": true,
- "reeferTemperature": 10,
- "reeferTemperatureUnit": "cel",
- "fittings": [
- "insulation"
], - "transportReferences": [
- {
- "description": "Datalogger",
- "number": "DTL01234567"
}
], - "grossWeight": 18567,
- "grossWeightUnit": "kgm",
- "sealNumbers": [
- "123456ABC"
]
}, - "emission": {
- "calculation": "notAvailable",
- "unit": "tne",
- "type": "notAvailable",
- "value": 0
}, - "distance": {
- "distance": 1635,
- "unit": "kmt"
}
}
]
}
Returns the list of locations for a specific shipment.
id required | integer <int64> Shipment Id |
units | string (UnitsEnum) Enum: "metric" "imperial" "imperialUk" Units in Metric, Imperial UK or Imperial US. If empty, it will be defaulted to metric. |
pageNumber | integer <int32> Default: 1 Page number. |
pageSize | integer <int32> Default: 10 Page size |
curl GET 'https://api.hillebrandgori.com/v5/shipments/{id}/locations' --header 'Accept: application/json' --header 'Authorization: Bearer <your-token>'
{- "_pagingInfo": {
- "totalItems": 0,
- "totalPages": 0,
- "hasPreviousPage": true,
- "hasNextPage": true,
- "itemsOnPage": 0,
- "pageNumber": 0,
- "pageSize": 0
}, - "items": [
- {
- "sequenceNumber": 3,
- "partyName": "ABCWarehouse",
- "address": {
- "cityName": "Rotterdam",
- "cityCode": "NLRTM",
- "countryName": "Netherlands",
- "countryCode": "NL",
- "countrySubEntityName": "Zuid Holland",
- "countrySubEntityCode": "ZH"
}, - "type": "address",
- "subType": "notApplicable",
- "status": null,
- "coordinate": {
- "latitude": 43.3518319,
- "longitude": -3.082039
}, - "arrivalDates": {
- "requestedDate": "2018-02-28T07:00:00",
- "estimatedDate": "2018-02-28T07:00:00",
- "actualDate": "2018-02-28T07:00:00",
- "forecastedDate": "2018-02-28T07:00:00",
- "daysLate": 3
}, - "departureDates": {
- "requestedDate": "2018-02-28T07:00:00",
- "estimatedDate": "2018-02-28T07:00:00",
- "actualDate": "2018-02-28T07:00:00",
- "forecastedDate": "2018-02-28T07:00:00",
- "daysLate": 3
}, - "temperature": {
- "degrees": 28,
- "unit": "cel",
- "band": "veryCold"
}, - "_links": {
- "href": "string",
- "rel": "self",
- "modifiedTimeStamp": 1580981375
}
}
]
}
Returns detailed information for a specific location for a specific shipment.
id required | integer <int64> Shipment Id |
sequenceNumber required | integer <int32> Location sequenceNumber |
units | string (UnitsEnum) Enum: "metric" "imperial" "imperialUk" Units in Metric, Imperial UK or Imperial US. If empty, it will be defaulted to metric. |
curl GET 'https://api.hillebrandgori.com/v5/shipments/{id}/locations/{sequenceNumber}' --header 'Accept: application/json' --header 'Authorization: Bearer <your-token>'
{- "sequenceNumber": 3,
- "partyName": "ABCWarehouse",
- "address": {
- "cityName": "Rotterdam",
- "cityCode": "NLRTM",
- "countryName": "Netherlands",
- "countryCode": "NL",
- "countrySubEntityName": "Zuid Holland",
- "countrySubEntityCode": "ZH"
}, - "type": "address",
- "subType": "notApplicable",
- "status": null,
- "coordinate": {
- "latitude": 43.3518319,
- "longitude": -3.082039
}, - "arrivalDates": {
- "requestedDate": "2018-02-28T07:00:00",
- "estimatedDate": "2018-02-28T07:00:00",
- "actualDate": "2018-02-28T07:00:00",
- "forecastedDate": "2018-02-28T07:00:00",
- "daysLate": 3
}, - "departureDates": {
- "requestedDate": "2018-02-28T07:00:00",
- "estimatedDate": "2018-02-28T07:00:00",
- "actualDate": "2018-02-28T07:00:00",
- "forecastedDate": "2018-02-28T07:00:00",
- "daysLate": 3
}, - "temperature": {
- "degrees": 28,
- "unit": "cel",
- "band": "veryCold"
}
}
Returns the list of product lines for a specific shipment.
id required | integer <int64> Shipment Id |
pageNumber | integer <int32> Default: 1 Page number. |
pageSize | integer <int32> Default: 10 Page size |
curl GET 'https://api.hillebrandgori.com/v5/shipments/{id}/productlines' --header 'Accept: application/json' --header 'Authorization: Bearer <your-token>'
{- "_pagingInfo": {
- "totalItems": 0,
- "totalPages": 0,
- "hasPreviousPage": true,
- "hasNextPage": true,
- "itemsOnPage": 0,
- "pageNumber": 0,
- "pageSize": 0
}, - "items": [
- {
- "id": 12345,
- "sequence": 1,
- "code": "70102-2016",
- "description": "Cavit Merlot",
- "quantity": 32,
- "quantityUnit": "Cases",
- "shortStock": 5,
- "volume": "6 x 1,5 lt",
- "hsCode": 220410
}
]
}
Returns a list of tasks belonging to a specific Shipment.
id required | integer <int64> Shipment Id |
taskStatuses | Array of strings (TaskStatusEnum) Items Enum: "open" "completed" Filter on Tasks of a certain Status. |
overdue | boolean Filter on overdue. False = no Filter, True = Filter on only Overdue Tasks. |
taskTypes | Array of strings (TaskTypeEnum) Items Value: "shprdy" Filter on certain Tasktype(s). |
curl GET 'https://api.hillebrandgori.com/v5/shipments/{id}/tasks' --header 'Accept: application/json' --header 'Authorization: Bearer <your-token>'
{- "items": [
- {
- "_links": {
- "href": "string",
- "rel": "self",
- "modifiedTimeStamp": 1580981375
}, - "id": 46897,
- "actionLink": {
- "href": "string",
- "rel": "self",
- "modifiedTimeStamp": 1580981375
}, - "type": {
- "code": "shprdy",
- "description": "Shipment ready for Transport"
}, - "status": "open",
- "dueDate": "2019-01-28T09:00:00",
- "creationDate": "2018-12-28T09:00:00",
- "completionDate": "2018-12-28T09:00:00",
- "completedBy": "string"
}
]
}
Retrieve all the possible Inventories
searchterm | string The searchterm the user has entered |
productCodes | Array of strings search for Inventories with a certain productCode. |
description | string search for Inventories with a certain productDescription. |
warehouseCountryNames | Array of strings search for Inventories with a Warehouse in a certain Country. |
warehouseCountries | Array of strings Search for warehouseCountry (or Countries) equal to criteria. Searchaction based on countrycode(s). eg 'NL'. |
warehouses | Array of strings search for Inventories with a certain Warehouse. |
principals | Array of strings search for Inventories with a certain Principal. |
owners | Array of strings search for Inventories with a certain Owner. |
soldBys | Array of strings search for Inventories with a certain soldBy Party. |
includeInactiveStock | boolean Default: false true = resultset with inactive Stock, false = result without inactive Stock |
sortBy | Array of strings (SortByEnum) Items Enum: "default" "productCode_ascending" "productCode_descending" "warehouse_ascending" "warehouse_descending" "warehouseCountryName_ascending" "warehouseCountryName_descending" "principal_ascending" "principal_descending" "owner_ascending" "owner_descending" "soldBy_ascending" "soldBy_descending" "quantity_ascending" "quantity_descending" "quantityAllocated_ascending" "quantityAllocated_descending" "quantityOrderedIn_ascending" "quantityOrderedIn_descending" "quantityOrderedOut_ascending" "quantityOrderedOut_descending" "quantityAvailable_ascending" "quantityAvailable_descending" "vintage_ascending" "vintage_descending" "quantityShortStock_ascending" "quantityShortStock_descending" "quantityUnit_ascending" "quantityUnit_descending" "volume_ascending" "volume_descending" Fieldnames and their order to sort on, parameter can be (re)used or chained multiple times. |
pageNumber | integer <int32> Default: 1 Page number. |
pageSize | integer <int32> Default: 10 Page size |
curl GET 'https://api.hillebrandgori.com/v2/inventories' --header 'Accept: application/json' --header 'Authorization: Bearer <your-token>'
{- "_pagingInfo": {
- "totalItems": 0,
- "totalPages": 0,
- "hasPreviousPage": true,
- "hasNextPage": true,
- "itemsOnPage": 0,
- "pageNumber": 0,
- "pageSize": 0
}, - "items": [
- {
- "_links": {
- "href": "string",
- "rel": "self",
- "modifiedTimeStamp": 1580981375
}, - "id": 0,
- "productCodes": [
- {
- "productCode": "A0VIRRO03XX15006",
- "role": "principal"
}
], - "description": "Vino Rosso Senza",
- "quantity": 50,
- "quantityAvailable": 20,
- "quantityBlocked": 50,
- "quantityAllocated": 30,
- "quantityOrderedIn": 1910,
- "quantityOrderedOut": 567,
- "quantityShortStock": 567,
- "quantityUnit": "Case",
- "volume": "12 x 75 cl",
- "warehouse": "JFH Bieffe Storage",
- "warehouseCountry": {
- "countryName": "Netherlands",
- "countryCode": "NL"
}, - "principal": "Group Wine and Spirits",
- "owner": "Wine Tastes Good Ltd.",
- "soldBy": "Wine Tastes Good Ltd.",
- "vintage": 2016
}
]
}
Retrieve the specific Inventory
id required | integer <int64> The ID of the Inventory. |
curl GET 'https://api.hillebrandgori.com/v2/inventories/{id}' --header 'Accept: application/json' --header 'Authorization: Bearer <your-token>'
{- "id": 0,
- "productCodes": [
- {
- "productCode": "A0VIRRO03XX15006",
- "role": "principal"
}
], - "description": "Red wine",
- "quantity": 50,
- "quantityBlocked": 50,
- "quantityAvailable": 20,
- "quantityAllocated": 30,
- "quantityOrderedIn": 1910,
- "quantityOrderedOut": 567,
- "quantityShortStock": 567,
- "quantityUnit": "Case",
- "volume": "12 x 75 cl",
- "hsCode": 220410,
- "warehouse": "JFH Bieffe Storage",
- "warehouseCountry": {
- "countryName": "Netherlands",
- "countryCode": "NL"
}, - "principal": "Group Wine and Spirits",
- "owner": "Wine Tastes Good Ltd.",
- "soldBy": "Wine Tastes Good Ltd.",
- "vintage": 2016
}
Retrieve the different lots belonging to an Inventory
id required | integer <int64> The ID of the Inventory. |
pageNumber | integer <int32> Default: 1 Page number. |
pageSize | integer <int32> Default: 10 Page size |
sortBy | Array of strings (SortByLotsEnum) Items Enum: "default" "number_ascending" "number_descending" "vintage_ascending" "vintage_descending" "quantity_ascending" "quantity_descending" "quantityAllocated_ascending" "quantityAllocated_descending" Fieldnames and their order to sort on, parameter can be (re)used or chained multiple times. |
curl GET 'https://api.hillebrandgori.com/v2/inventories/{id}/lots' --header 'Accept: application/json' --header 'Authorization: Bearer <your-token>'
{- "_pagingInfo": {
- "totalItems": 0,
- "totalPages": 0,
- "hasPreviousPage": true,
- "hasNextPage": true,
- "itemsOnPage": 0,
- "pageNumber": 0,
- "pageSize": 0
}, - "items": [
- {
- "_links": {
- "href": "string",
- "rel": "self",
- "modifiedTimeStamp": 1580981375
}, - "id": 0,
- "number": 4526348,
- "vintage": 2016,
- "quantity": 50,
- "quantityAllocated": 30,
- "quantityUnit": "Case",
- "information": "string"
}
]
}
Retrieve the involved Parties in the Inventory
id required | integer <int64> The ID of the Inventory. |
pageNumber | integer <int32> Default: 1 Page number. |
pageSize | integer <int32> Default: 10 Page size |
curl GET 'https://api.hillebrandgori.com/v2/inventories/{id}/parties' --header 'Accept: application/json' --header 'Authorization: Bearer <your-token>'
{- "_pagingInfo": {
- "totalItems": 0,
- "totalPages": 0,
- "hasPreviousPage": true,
- "hasNextPage": true,
- "itemsOnPage": 0,
- "pageNumber": 0,
- "pageSize": 0
}, - "items": [
- {
- "id": 4568,
- "productCodes": [
- {
- "productCode": "A0VIRRO03XX15006",
- "role": "principal"
}
], - "name": "abcParty",
- "coordinates": {
- "latitude": 43.3518319,
- "longitude": -3.082039
}, - "address": {
- "townName": "New York City",
- "townCode": "NYC",
- "countryName": "USA",
- "countryCode": "US",
- "countrySubEntityName": "New York",
- "countrySubEntityCode": "NY",
- "addressLine1": "129W 27th St",
- "addressLine2": "129W 27th St",
- "addressLine3": "129W 27th St",
- "postalCode": 10001,
- "formattedAddress": [
- "string"
]
}
}
]
}
Retrieve the shipments related to a Inventory
id required | integer <int64> The ID of the Inventory. |
direction | string Enum: "in" "out" In or Out to get a list of all quantities gone in or out by a Shipment. If the parameter is not set then the default is 'in'. |
sortByIn | Array of strings (SortByInEnum) Items Enum: "default" "reference_ascending" "reference_descending" "expectedReceiptDate_ascending" "expectedReceiptDate_descending" Fieldnames and their order to sort on, parameter can be (re)used or chained multiple times. |
sortByOut | Array of strings (SortByOutEnum) Items Enum: "default" "reference_ascending" "reference_descending" "requiredShipDate_ascending" "requiredShipDate_descending" Fieldnames and their order to sort on, parameter can be (re)used or chained multiple times. |
pageNumber | integer <int32> Default: 1 Page number. |
pageSize | integer <int32> Default: 10 Page size |
curl GET 'https://api.hillebrandgori.com/v2/inventories/{id}/shipments' --header 'Accept: application/json' --header 'Authorization: Bearer <your-token>'
{- "_pagingInfo": {
- "totalItems": 0,
- "totalPages": 0,
- "hasPreviousPage": true,
- "hasNextPage": true,
- "itemsOnPage": 0,
- "pageNumber": 0,
- "pageSize": 0
}, - "items": [
- {
- "_links": {
- "href": "string",
- "rel": "self",
- "modifiedTimeStamp": 1580981375
}, - "id": 0,
- "references": [
- {
- "reference": "ABC3456789",
- "role": "agent"
}
], - "requiredShipDate": "2018-01-28T08:00:00",
- "distributor": "distributorABC",
- "quantityOrderedOut": 100,
- "quantityAllocated": 100,
- "volume": "12 x 75 cl",
- "quantityUnit": "Case",
- "status": "notReady"
}
]
}
Retrieve all available parties in the Inventorieslist
roles | Array of strings (InventoryPartyRoleEnum) Items Enum: "principal" "location" "owner" "soldBy" Search for 1 or multiple role(s) equal to criteria. |
curl GET 'https://api.hillebrandgori.com/v2/inventories/parties' --header 'Accept: application/json' --header 'Authorization: Bearer <your-token>'
[- {
- "role": "principal",
- "name": "ABCParty",
- "countryName": "USA",
- "_links": {
- "href": "string",
- "rel": "self",
- "modifiedTimeStamp": 1580981375
}, - "id": 4568
}
]
Returns a list of all used countries in the inventories.
curl GET 'https://api.hillebrandgori.com/v2/inventories/warehouseCountries' --header 'Accept: application/json' --header 'Authorization: Bearer <your-token>'
[- {
- "code": "NL",
- "name": "Netherlands"
}
]
Returns invoices related to shipments for a customer
references | Array of strings Search for 1 or multiple reference(s) (shipmentreference, invoicenumber) equal to criteria. |
invoiceDateFrom | string <date> This search criterion specifies the range for the dates of the invoices to be included in the search results. |
invoiceDateTo | string <date> This search criterion specifies the range for the dates of the invoices to be included in the search results. |
paymentDueDateFrom | string <date> This search criterion specifies the range for the dates of the invoices to be included in the search results. |
paymentDueDateTo | string <date> This search criterion specifies the range for the dates of the invoices to be included in the search results. |
invoiceStatusCodes | Array of strings (InvoiceStatusEnum) Items Enum: "overdue" "open" "paid" "processing" Search for 1 or multiple status(es) equal to criteria. |
currencyCodes | Array of strings Search for 1 or multiple currencies equal to criteria. |
shipmentId | integer <int64> Search for invoice(s) related to 1 shipment |
invoiceType | string (InvoiceTypeEnum) Enum: null "invoice" "creditNote" Search for invoices on Type. |
sortBy | Array of strings (InvoiceSortByEnum) Items Enum: "default" "invoiceStatusCode_ascending" "invoiceStatusCode_descending" "invoiceNumber_ascending" "invoiceNumber_descending" "invoiceDate_ascending" "invoiceDate_descending" "paymentDueDate_ascending" "paymentDueDate_descending" "totalAmount_ascending" "totalAmount_descending" "openAmount_ascending" "openAmount_descending" "currencyCode_ascending" "currencyCode_descending" Fieldnames and their order to sort on, parameter can be (re)used or chained multiple times. |
pageNumber | integer <int32> Default: 1 Page number. |
pageSize | integer <int32> Default: 10 Page size |
curl GET 'https://api.hillebrandgori.com/v1/invoices' --header 'Accept: application/json' --header 'Authorization: Bearer <your-token>'
{- "_pagingInfo": {
- "totalItems": 0,
- "totalPages": 0,
- "hasPreviousPage": true,
- "hasNextPage": true,
- "itemsOnPage": 0,
- "pageNumber": 0,
- "pageSize": 0
}, - "items": [
- {
- "_links": {
- "href": "string",
- "rel": "self",
- "modifiedTimeStamp": 1580981375
}, - "id": 46897,
- "invoiceNumber": 9876564321,
- "invoiceStatus": "overdue",
- "invoiceType": null,
- "invoiceDate": "2018-02-28T07:00:00",
- "paymentDueDate": "2018-03-28T07:00:00",
- "currencyCode": "USD",
- "totalAmount": 1923.07,
- "openAmount": 923.07,
- "shipmentReferences": [
- {
- "_links": {
- "href": "string",
- "rel": "self",
- "modifiedTimeStamp": 1580981375
}, - "id": 0,
- "shipmentReference": "FR03456789",
- "role": "agent"
}
], - "isOnlinePayable": true,
- "legalEntityCode": "string"
}
]
}
Returns general information for a specific invoice
id required | integer <int64> Invoice Id |
curl GET 'https://api.hillebrandgori.com/v1/invoices/{id}' --header 'Accept: application/json' --header 'Authorization: Bearer <your-token>'
{- "id": 46897,
- "invoiceNumber": 7411732938,
- "invoiceStatus": "overdue",
- "totalAmount": 2307.68,
- "totalAmountExclTax": 1923.07,
- "totalAmountTax": 384.61,
- "openAmount": 2307.68,
- "invoiceType": null,
- "invoiceDate": "2018-02-28T07:00:00",
- "paymentDueDate": "2018-03-28T07:00:00",
- "currencyCode": "USD",
- "billedFromParty": "Hillebrand Benelux B.V.",
- "billedFromAddress": {
- "townName": "New York City",
- "townCode": "NYC",
- "countryName": "USA",
- "countryCode": "US",
- "countrySubEntityName": "New York",
- "countrySubEntityCode": "NY",
- "addressLine1": "129W 27th St",
- "addressLine2": "129W 27th St",
- "addressLine3": "129W 27th St",
- "formattedAddress": [
- "string"
], - "postalCode": 10001
}, - "billedToParty": "ABCSupermarket",
- "billedToAddress": {
- "townName": "New York City",
- "townCode": "NYC",
- "countryName": "USA",
- "countryCode": "US",
- "countrySubEntityName": "New York",
- "countrySubEntityCode": "NY",
- "addressLine1": "129W 27th St",
- "addressLine2": "129W 27th St",
- "addressLine3": "129W 27th St",
- "formattedAddress": [
- "string"
], - "postalCode": 10001
}, - "freeText": "Invoice 123456789 is cancelled by this Credit note.",
- "footerText": "Hillebrand Canada Inc is a registered member of CIFFA. Shipments are subject to the Standard Trading Conditions adopted by the Canadian International Freight Forwarders Association Inc.",
- "isOnlinePayable": true,
- "legalEntityCode": "string"
}
Returns a list of documents associated to a specific Invoice.
id required | integer <int64> Invoice Id |
pageNumber | integer <int32> Default: 1 Page number. |
pageSize | integer <int32> Default: 10 Page size |
sortBy | Array of strings (DocumentSortByEnum) Items Enum: "default" "documentTypeCode_ascending" "documentTypeCode_descending" "user_ascending" "user_descending" "creationDate_ascending" "creationDate_descending" "fileName_ascending" "fileName_descending" Fieldnames and their order to sort on, parameter can be (re)used or chained multiple times. |
curl GET 'https://api.hillebrandgori.com/v1/invoices/{id}/documents' --header 'Accept: application/json' --header 'Authorization: Bearer <your-token>'
{- "_pagingInfo": {
- "totalItems": 0,
- "totalPages": 0,
- "hasPreviousPage": true,
- "hasNextPage": true,
- "itemsOnPage": 0,
- "pageNumber": 0,
- "pageSize": 0
}, - "items": [
- {
- "_links": {
- "href": "string",
- "rel": "self",
- "modifiedTimeStamp": 1580981375
}, - "ticket": "House BLĀ¤-5176fede-e076-4ea1-9658-7efbc464c841.pdf",
- "documentType": {
- "code": "cin",
- "description": "Carrier Bill of lading"
}, - "documentDateTime": "2018-01-28T09:00:00",
- "fileName": "Invoice-123456_Hillebrand.pdf",
- "fileExtension": "pdf",
- "references": [
- {
- "referenceType": "File",
- "referenceValue": "SET-US-1808-7116"
}
], - "sharedParties": [
- 0
], - "comment": "string"
}
]
}
Returns a list of invoice lines of a specific invoice
id required | integer <int64> Invoice Id |
pageNumber | integer <int32> Default: 1 Page number. |
pageSize | integer <int32> Default: 10 Page size |
curl GET 'https://api.hillebrandgori.com/v1/invoices/{id}/lines' --header 'Accept: application/json' --header 'Authorization: Bearer <your-token>'
{- "_pagingInfo": {
- "totalItems": 0,
- "totalPages": 0,
- "hasPreviousPage": true,
- "hasNextPage": true,
- "itemsOnPage": 0,
- "pageNumber": 0,
- "pageSize": 0
}, - "items": [
- {
- "_links": {
- "href": "string",
- "rel": "self",
- "modifiedTimeStamp": 1580981375
}, - "id": 12345,
- "sequence": 1,
- "lineDescription": "Custom Clearance",
- "lineAmount": 809.2,
- "lineAmountCurrencyCode": "EUR",
- "quantityUnit": "container",
- "quantity": 1,
- "unitAmount": 950,
- "unitAmountCurrencyCode": "USD",
- "shipmentReferences": [
- {
- "_links": {
- "href": "string",
- "rel": "self",
- "modifiedTimeStamp": 1580981375
}, - "id": 0,
- "shipmentReference": "FR03456789",
- "role": "agent"
}
]
}
]
}
Get contact information for a specific reference
id required | string Contact Id |
curl GET 'https://api.hillebrandgori.com/v1/contacts/{id}' --header 'Accept: application/json' --header 'Authorization: Bearer <your-token>'
{- "id": 46897,
- "party": {
- "role": "principal",
- "name": "ABCParty",
- "countryName": "USA",
- "_links": {
- "href": "string",
- "rel": "self",
- "modifiedTimeStamp": 1580981375
}, - "id": 4568
}, - "name": "ABCContact",
- "telephoneNumber": "+1 111-222-3333",
- "userActsFor": false
}
Returns the specific Party details
id required | integer <int64> party Id |
curl GET 'https://api.hillebrandgori.com/v1/parties/{id}' --header 'Accept: application/json' --header 'Authorization: Bearer <your-token>'
{- "id": 12,
- "name": "ABCParty",
- "address": {
- "townName": "New York City",
- "townCode": "NYC",
- "countryName": "USA",
- "countryCode": "US",
- "countrySubEntityName": "New York",
- "countrySubEntityCode": "NY",
- "addressLine1": "129W 27th St",
- "addressLine2": "129W 27th St",
- "addressLine3": "129W 27th St",
- "postalCode": 10001,
- "formattedAddress": [
- "string"
]
}
}
Returns all possible addresses for a specific party.
id required | integer <int64> party Id |
includeHistoricalPickupAddresses required | boolean Default: false Filter on the usage of historical Pickup Addresses. False = no historical pickupAddresses, True = All Addresses including historical pickupAddresses. |
curl GET 'https://api.hillebrandgori.com/v1/parties/{id}/addresses' --header 'Accept: application/json' --header 'Authorization: Bearer <your-token>'
[- {
- "townName": "New York City",
- "townCode": "NYC",
- "countryName": "USA",
- "countryCode": "US",
- "countrySubEntityName": "New York",
- "countrySubEntityCode": "NY",
- "addressLine1": "129W 27th St",
- "addressLine2": "129W 27th St",
- "addressLine3": "129W 27th St",
- "postalCode": 10001,
- "formattedAddress": [
- "string"
], - "id": 12,
- "name": "ABCParty",
- "coordinates": {
- "latitude": 43.3518319,
- "longitude": -3.082039
}
}
]
curl GET 'https://api.hillebrandgori.com/v1/webhooks/me' --header 'Accept: application/json' --header 'Authorization: Bearer <your-token>'
{- "authorization": "YmxhOmJsYQ==",
- "authorizationMode": "basic",
- "active": true,
- "eventTypes": [
- "shpcusarrcnf"
]
}
Create new subscription (or overwrite the previous one)
uri | string The endpoint of the subscriber the events should be posted to. |
authorization | string authorization string to use against uri. |
authorizationMode | string (AuthorisationModeEnum) Enum: "basic" "other" AuthorisationMode description:
|
active | boolean subscription status, true = active or false = paused |
eventTypes | Array of strings (webhookEventTypeEnum) Items Enum: "shpcusarrcnf" "shpcusarrcnfchg" "shpprtarrcnf" "shpprtarrcnfchg" "shpairarrcnf" "shpairarrcnfchg" "shpsupdepcnf" "shpsupdepcnfchg" "shpprtdepcnf" "shpprtdepcnfchg" "shpairdepcnf" "shpairdepcnfchg" "shpcusarrpln" "shpcusarrplnchg" "shpprtarrpln" "shpprtarrplnchg" "shpairarrpln" "shpairarrplnchg" "shpsupdeppln" "shpsupdepplnchg" "shpprtdeppln" "shpprtdepplnchg" "shpairdeppln" "shpairdepplnchg" "shpimpcsmclr" "shpimpcsmclrchg" "shpexharrpln" "shpexharrplnchg" "shpexharrcnf" "shpexharrcnfchg" "sphexhdeppln" "sphexhdepplnchg" "shpexhdepcnf" "shpexhdepcnfchg" "shppolarrcnf" "shppolarrcnfchg" "shppoxarrpln" "shppoxarrplnchg" "shppoxarrcnf" "shppoxarrcnfchg" "shppoxdeppln" "shppoxdepplnchg" "shppoxdepcnf" "shppoxdepcnfchg" "shppoddepcnf" "shppoddepcnfchg" "shpimharrpln" "shpimharrplnchg" "shpimharrcnf" "shpimharrcnfchg" "sphimhdeppln" "sphimhdepplnchg" "shpimhdepcnf" "shpimhdepcnfchg" "shprdy" "shprdychg" |
{- "authorization": "YmxhOmJsYQ==",
- "authorizationMode": "basic",
- "active": true,
- "eventTypes": [
- "shpcusarrcnf"
]
}
{- "statusCode": 400,
- "error": "badRequest",
- "message": "The value 'a' is not valid for PageSize."
}
Overwrite subscription (or create a new one)
uri | string The endpoint of the subscriber the events should be posted to. |
authorization | string authorization string to use against uri. |
authorizationMode | string (AuthorisationModeEnum) Enum: "basic" "other" AuthorisationMode description:
|
active | boolean subscription status, true = active or false = paused |
eventTypes | Array of strings (webhookEventTypeEnum) Items Enum: "shpcusarrcnf" "shpcusarrcnfchg" "shpprtarrcnf" "shpprtarrcnfchg" "shpairarrcnf" "shpairarrcnfchg" "shpsupdepcnf" "shpsupdepcnfchg" "shpprtdepcnf" "shpprtdepcnfchg" "shpairdepcnf" "shpairdepcnfchg" "shpcusarrpln" "shpcusarrplnchg" "shpprtarrpln" "shpprtarrplnchg" "shpairarrpln" "shpairarrplnchg" "shpsupdeppln" "shpsupdepplnchg" "shpprtdeppln" "shpprtdepplnchg" "shpairdeppln" "shpairdepplnchg" "shpimpcsmclr" "shpimpcsmclrchg" "shpexharrpln" "shpexharrplnchg" "shpexharrcnf" "shpexharrcnfchg" "sphexhdeppln" "sphexhdepplnchg" "shpexhdepcnf" "shpexhdepcnfchg" "shppolarrcnf" "shppolarrcnfchg" "shppoxarrpln" "shppoxarrplnchg" "shppoxarrcnf" "shppoxarrcnfchg" "shppoxdeppln" "shppoxdepplnchg" "shppoxdepcnf" "shppoxdepcnfchg" "shppoddepcnf" "shppoddepcnfchg" "shpimharrpln" "shpimharrplnchg" "shpimharrcnf" "shpimharrcnfchg" "sphimhdeppln" "sphimhdepplnchg" "shpimhdepcnf" "shpimhdepcnfchg" "shprdy" "shprdychg" |
{- "authorization": "YmxhOmJsYQ==",
- "authorizationMode": "basic",
- "active": true,
- "eventTypes": [
- "shpcusarrcnf"
]
}
{- "statusCode": 400,
- "error": "badRequest",
- "message": "The value 'a' is not valid for PageSize."
}
Get available/allowed eventtypes and their meaning
curl GET 'https://api.hillebrandgori.com/v1/webhooks/me/eventTypes' --header 'Accept: application/json' --header 'Authorization: Bearer <your-token>'
[- {
- "eventType": "shpcusarrcnf",
- "description": "Confirm Arrival ship to location"
}
]
callbackUri required | string callbackUri |
subscription payload
code | string (webhookEventTypeEnum2) Enum: "shpcusarrcnf" "shpcusarrcnfchg" "shpprtarrcnf" "shpprtarrcnfchg" "shpairarrcnf" "shpairarrcnfchg" "shpsupdepcnf" "shpsupdepcnfchg" "shpprtdepcnf" "shpprtdepcnfchg" "shpairdepcnf" "shpairdepcnfchg" "shpcusarrpln" "shpcusarrplnchg" "shpprtarrpln" "shpprtarrplnchg" "shpairarrpln" "shpairarrplnchg" "shpsupdeppln" "shpsupdepplnchg" "shpprtdeppln" "shpprtdepplnchg" "shpairdeppln" "shpairdepplnchg" "shpimpcsmclr" "shpimpcsmclrchg" "shpexharrpln" "shpexharrplnchg" "shpexharrcnf" "shpexharrcnfchg" "sphexhdeppln" "sphexhdepplnchg" "shpexhdepcnf" "shpexhdepcnfchg" "shppolarrcnf" "shppolarrcnfchg" "shppoxarrpln" "shppoxarrplnchg" "shppoxarrcnf" "shppoxarrcnfchg" "shppoxdeppln" "shppoxdepplnchg" "shppoxdepcnf" "shppoxdepcnfchg" "shppoddepcnf" "shppoddepcnfchg" "shpimharrpln" "shpimharrplnchg" "shpimharrcnf" "shpimharrcnfchg" "sphimhdeppln" "sphimhdepplnchg" "shpimhdepcnf" "shpimhdepcnfchg" "shprdy" "shprdychg" The event type code:
|
description | string |
timestamp | integer <int64> The date/time the Event is generated. |
shipmentReferences | Array of strings |
object or null (webhookLocation2) | |
eventDate | string <date> |
[- {
- "code": "shpcusarrcnf",
- "description": "Confirmed arrival at ship to location",
- "timestamp": 1580981375,
- "shipmentReferences": [
- "AFW123456789"
], - "location": {
- "name": "Kumport"
}, - "eventDate": "2022-04-03"
}
]