Consignment API
Author:
Fluent Commerce
Changed on:
3 July 2024
Overview
The Consignment API is responsible for retrieving and updating the status of fulfilment's managed through the Fluent Retail platform. Users can also add consignment details to articles on fulfilment's booked outside of the platform through the Consignment API.
Key points
- Consignment Properties
- What you can do with Consignment
- Response on Failures
Consignment API
Consignment Properties
Below are the properties available in the Comment object which can be updated and retrieved through the APIs in this document.
1. consignmentId
Type: Long
1{ "consignmentId" : "1808656" }Language: json
Name: Description
Description:
[Warning: empty required content area]The unique identifier assigned by Fluent Commerce.
2. carrierId
Type: String
1{ "carrierId" : "21" }Language: json
Name: Description
Description:
[Warning: empty required content area]The unique identifier assigned to the carrier.
3. carrierName
Type: String
1{ "carrierName" : "Temando" }Language: json
Name: Description
Description:
[Warning: empty required content area]The carrier name
4. consignmentRef
Type: String
1{ "consignmentRef" : "25018856" }Language: json
Name: Description
Description:
[Warning: empty required content area]The external consignment reference assigned by the carrier.
5. labelUrl
Type: String
1{ "labelUrl" : "de6cb885-81d3-40ad-8ade-0177a8c58b8d.pdf" }Language: json
Name: Description
Description:
[Warning: empty required content area]The unique identifier assigned by Fluent Commerce.
6. status
Type: Enum
1{ "status" : "ACTIVE_SENT" }Language: json
Name: Description
Description:
[Warning: empty required content area]The status of the consignment
Valid values are:
- ASSIGNED - A courier booking has been initiated. An API call has been made to the courier.
- ACTIVE_LODGED - A consignment has been created with a courier. The booking has been confirmed.
- ACTIVE_SENT - The consignment has been picked up by the courier.
- COMPLETE - The shipment has been delivered.
- FAILED - The courier booking has failed. The store associate will be required to follow in-store procedures to book the courier. Our system will not be updated once the booking has been made.
7. retailerId
Type: String
1{ "retailerId" : "197" }Language: json
Name: Description
Description:
[Warning: empty required content area]The retailer identifier assigned by Fluent Commerce.
8. orderSummaryUrl
Type: String
1{ "orderSummaryUrl" : NULL }Language: json
Name: Description
Description:
[Warning: empty required content area]Manifest url for consignment.
9. createdOn
Type: DateTime
1{ "createdOn" : "2016-11-06T23:41:12.242Z" }Language: json
Name: Description
Description:
[Warning: empty required content area]Date/time when the Consignment was created.
10. shipmentId
Type: String
1{ "shipmentId" : "765403" }Language: json
Name: Description
Description:
[Warning: empty required content area]The unique identifier assigned to the shipment.
11. consignmentReason
Type: String
1{ "consignmentReason" : "Priority delivery" }Language: json
Name: Description
Description:
[Warning: empty required content area]The consignment reason property. Provided reason from 3rd party courier.
What you can do with Consignment
View Consignment Details
Retrieve details of the Consignment.
GET:
`/api/v4.1/consignment/{consignmentId}`Request and response
Request parameters and sample.
Consignment request
`/api/v4.1/consignment/{consignmentId}`1/api/v4.1/consignment/1808656Language: java
Name: Example request
Description:
[Warning: empty required content area]Response Parameters and sample
Consignment response
1ConsignmentResponse {
2
3 carrierId (string),
4 carrierName (string),
5 consignmentId (string),
6 consignmentRef (string),
7 labelUrl (string),
8 status = ['ASSIGNED', 'ACTIVE_LODGED', 'ACTIVE_SENT', 'COMPLETE', 'FAILED'] (string),
9 retailerId (string),
10 orderSummaryUrl (string),
11 createdOn (string)
12 }Language: java
Name: Consignment Response Example
Description:
[Warning: empty required content area]1{
2 "carrierId":"21",
3 "carrierName":"temando",
4 "consignmentId":"1808656",
5 "consignmentRef":"25018856",
6 "labelUrl":"de6cb885-81d3-40ad-8ade-0177a8c58b8d.pdf",
7 "status":"ACTIVE_SENT",
8 "retailerId":"197",
9 "orderSummaryUrl":"null",
10 "createdOn":"2015-06-23T07:58:58.000+0000"
11}Language: java
Name: Example Response
Description:
[Warning: empty required content area]Update Consignment Details
Edit the Consignment information.
PUT:
`/api/v4.1/consignment`Request and response
Request parameters and sample
Consignment request
1ConsignmentResponse {
2 consignmentId (long, compulsory),
3 carrierId (string, optional),
4 carrierName (string, optional),
5 consignmentRef (string, optional),
6 labelUrl (string, optional),
7 shipmentId (string, optional),
8 consignmentReason (string, optional),
9 status = ['ASSIGNED', 'ACTIVE_LODGED', 'ACTIVE_SENT', 'COMPLETE', 'FAILED'] (string, optional),
10 retailerId (string, compulsory),
11 orderSummaryUrl (string, optional),
12 }Language: java
Name: Consignment Request Example
Description:
[Warning: empty required content area]1{
2 "consignmentId":"1808656",
3 "carrierId":"21",
4 "carrierName":"temando",
5 "consignmentRef":"25018856",
6 "labelUrl":"de6cb885-81d3-40ad-8ade-0177a8c58b8d.pdf",
7 "shipmentId":"765403",
8 "consignmentReason":"",
9 "status":"ACTIVE_SENT",
10 "retailerId":"197",
11 "orderSummaryUrl":"null",
12}Language: java
Name: Example Request
Description:
[Warning: empty required content area]Response Parameters and Sample
1SuccessMessageResponse {
2 id (object, optional),
3 message (string, optional),
4 status (string, optional)
5 }Language: java
Name: Consignment response
Description:
[Warning: empty required content area]1{
2 "id":"1808656"
3}Language: json
Name: Example response
Description:
[Warning: empty required content area]Response on Failures
NAME | TYPE | DESCRIPTION |
error | Array | Array of errors |
message | String | Additional information on the code Unauthorized | Bad Request | Forbidden | Not Found | Status 500 Error |
code | String | Status Code for the above messages 401 | 400 | 403 | 404 | 500 |
