Quotes Flow
The Quotes flow is intended as a back-end customer service integration to help you resolve delivery issues that require manual intervention. In this flow, a consignment is created and then allocated to a carrier service based on a specific quote for that consignment.
The Quotes flow is useful to your business for:
- Customer contact centre use.
- In store delivery booking.
- ERP workflows (e.g. SAP, Oracle).
There are five steps to the flow:
- Create the consignment - Use the Create Consignment endpoint to record the details of a new consignment.
- Get quotes for the consignment - Use the Get Quotes by Consignment Reference endpoint to get delivery quotes for the consignment.
- Select a quote - Use the Allocate With Quote endpoint to select one of the returned quotes.
- Get the consignment's labels - Use the Get Labels in Format endpoint to get the delivery label for your consignment.
- Manifest the consignment - Use the Manifest Consignments from Query endpoint to send consignment data to the selected carrier.
This section gives more detail on each step of the flow and provides worked examples.
Step 1: Creating Consignments
POST https://api.electioapp.com/consignments
The first step toward manifesting a consignment is to create that consignment in Ship.
Consignments are created using the Create Consignment endpoint, which takes information about new consignments, adds them to the database, and returns a link to the newly-created consignment, including its {consignmentReference}. A newly created consignment has a {consignmentState} of Unallocated.
As a minimum, the Create Consignments endpoint requires you to send package weights and dimensions, origin address, and destination address data.
Note
- For full reference information on the Create Consignment endpoint, see the Create Consignment page of the API reference.
- For a user guide explaining the Create Consignment endpoint, see the Creating New Consignments page.
Create Consignments Example
These examples show the creation of a fairly standard consignment. In this case, we have an outbound consignment comprising a single package with a single item inside it.
After receiving the request, Ship returns a {consignmentReference} of EC-000-05B-MMA. Many of Ship's functions require you to provide a {consignmentReference} as a parameter. Therefore, you should store the {consignmentReference} for later use.
POST https://api.electioapp.com/consignments
{
"ConsignmentReferenceProvidedByCustomer": "MYCONS-098998",
"Source": "Api",
"MetaData": [
{
"KeyValue": "Restock_Date",
"DateTimeValue": "2019-06-18T00:00:00+00:00"
}
],
"Packages": [
{
"Items": [
{
"Sku": "SKU093434",
"Model": "ITM-002",
"Description": "Striped Bamboo Red/White",
"CountryOfOrigin": {
"IsoCode": {
"TwoLetterCode": "GB"
}
},
"HarmonisationCode": "Harmonisation_Code",
"Weight": {
"Value": 0.5,
"Unit": "Kg"
},
"Dimensions": {
"Unit": "Cm",
"Width": 10.0,
"Length": 10.0,
"Height": 10.0
},
"Value": {
"Amount": 5.99,
"Currency": {
"IsoCode": "GBP"
}
},
"ItemReferenceProvidedByCustomer": "ITEMREF-098",
"Barcode": {
"Code": "09887-091221",
"BarcodeType": "Code39"
},
"MetaData": [
{
"KeyValue": "Picker",
"StringValue": "David Thomas"
}
],
"Quantity": 1,
"Unit": "Box",
"HarmonisationKeyWords": [
"Keyword1"
],
"ContentClassification": "Unrestricted",
"ContentClassificationDetails": "NotSpecified"
}
],
"PackageReferenceProvidedByCustomer": "MYPACK-00923",
"Weight": {
"Value": 0.5,
"Unit": "Kg"
},
"Dimensions": {
"Unit": "Cm",
"Width": 10.0,
"Length": 10.0,
"Height": 10.0
},
"Description": "Socks",
"Value": {
"Amount": 5.99,
"Currency": {
"IsoCode": "GBP"
}
},
"Barcode": {
"Code": "09887-091221",
"BarcodeType": "Code39"
},
"MetaData": [
{
"KeyValue": "WMS-REF",
"IntValue": 77656555
}
]
}
],
"CustomsDocumentation": {
"DesignatedPersonResponsible": "Peter McPetersson",
"ImportersVatNumber": "02345555",
"CategoryType": "Other",
"ShipperCustomsReference": "CREF0001",
"ImportersTaxCode": "TC001",
"ImportersTelephone": "0161123456",
"ImportersFax": "01611124547",
"ImportersEmail": "peter.mcpetersson@test.com",
"CN23Comments": "Comments",
"ReferencesOfAttachedInvoices": [
"INV001"
],
"ReferencesOfAttachedCertificates": [
"CERT001"
],
"ReferencesOfAttachedLicences": [
"LIC001"
],
"CategoryTypeExplanation": "Explanation",
"DeclarationDate": "2019-06-14T00:00:00+00:00",
"OfficeOfPosting": "Manchester",
"ReasonForExport": "Sale",
"ShippingTerms": "CFR",
"ShippersVatNumber": "874541414",
"ReceiversTaxCode": "TC5454",
"ReceiversVatNumber": "8745474",
"InvoiceDate": "2019-06-14T00:00:00+00:00"
},
"Addresses": [
{
"AddressType": "Origin",
"ShippingLocationReference": "EDC5_Electio",
"IsCached": false
},
{
"AddressType": "Destination",
"Contact": {
"Title": "Mr",
"FirstName": "Peter",
"LastName": "McPetersson",
"Telephone": "07702123456",
"Mobile": "07702123456",
"LandLine": "0161544123",
"Email": "peter.mcpetersson@test.com"
},
"CompanyName": "Test Company (UK) Ltd.",
"AddressLine1": "13 Porter Street",
"AddressLine2": "Pressington",
"AddressLine3": "Carlsby",
"Town": "Manchester",
"Region": "Greater Manchester",
"Postcode": "M1 5WG",
"Country": {
"Name": "Great Britain",
"IsoCode": {
"TwoLetterCode": "GB"
}
},
"SpecialInstructions": "Gate code: 4454",
"LatLong": {
"Latitude": 53.474220,
"Longitude": -2.246049
},
"IsCached": false
}
],
"Direction": "Outbound"
}
Step 2: Getting Quotes by Consignment Reference
GET https://api.electioapp.com/quotes/consignment/{consignmentReference}
Once you've created a consignment, you'll need to use the Get Quotes by Consignment Reference endpoint to get some delivery quotes for it.
Get Quotes by Consignment Reference returns quotes based on the details of an existing consignment. Specifically, it takes a {consignmentReference} as a path parameter and returns an array of {Quotes} for that consignment, as well as a list of services that were unable to quote for the consignment.
Note
- For full reference information on the Get Quotes by Consignment Reference endpoint, see the Get Quotes by Consignment Reference page of the API reference.
- For a user guide on quotes in Ship, see the Managing Quotes section.
Get Quotes By Consignment Reference Example
The example shows a Get Quotes by Consignment Reference request and its accompanying response. In this case, Ship has returned two quotes for the service. The next step in the process is to select one of those quotes.
https://api.electioapp.com/quotes/consignment/EC-000-05B-1CM
Step 3: Selecting a Quote
PUT https://api.electioapp.com/allocation/{consignmentReference}/allocatewithquote/{quoteReference}
To allocate an individual consignment based on a specific delivery quote from a carrier, use the Allocate With Quote endpoint.
The Allocate With Quote endpoint takes the {consignmentReference} of the consignment you want to allocate and the {quoteReference} of a particular quote. Once the request is received Ship attempts to allocate the consignment to the carrier service specified in the quote, and returns an Allocation Summary.
Note
- For full reference information on the Allocate With Quote endpoint, see the Allocate With Quote page of the API reference.
- For a user guide on allocating to specific delivery quotes, see the Allocating to a Specific Quote page.
Allocate With Quote Example
The example shows a request to allocate a consignment with a {consignmentReference} of EC-000-05B-N40 to the carrier service associated with a quote that has the {quoteReference} 112236d5-4460-492f-a6bd-aa3f00f62dfb.
PUT https://api.electioapp.com/allocation/EC-000-05B-N40/allocatewithquote/112236d5-4460-492f-a6bd-aa3f00f62dfb
Step 4: Getting Consignment Labels
GET https://api.electioapp.com/labels/{consignmentReference}/{labelFormat}
When a consignment is allocated, Ship generates labels for each package in that consignment. You can retrieve these delivery labels via the Get Labels in Format endpoint.
The Get Labels in Format endpoint takes a {consignmentReference} and {labelFormat} as path parameters. Ship returns all package labels associated with that consignment as a base64-encoded byte array that decodes to the format requested.
Note
- For full reference information on the Get Labels in Format endpoint, see the Get Labels in Format page of the API reference.
- For a user guide on retrieving labels in Ship, see the Getting Labels page.
Get Labels in Format Example
The example shows a request to get PDF labels for a consignment with a {consignmentReference} of EC-000-05B-MMA. The file data in the response has been truncated for clarity.
You will need to decode the File's Base64 data in order to view or print the label. If you are unsure how to do so, see the MDN docs for more information.
GET https://api.electioapp.com/labels/EC-000-05B-MMA/pdf
Step 4b (Optional): Getting Customs Docs
GET https://api.electioapp.com/consignments/docs/{consignmentReference}
When shipping internationally, Ship will automatically determine if customs documentation is necessary for a consignment, and generate documents where required. You can retrieve customs documentation via the Get Customs Documents endpoint.
The Get Customs Documents endpoint takes a {consignmentReference} as a path parameter. If CN22/CN23 or commercial invoice documents exist for the specified consignment, then Ship returns these documents as a base64-encoded byte array that will decode to a PDF document.
Note
- For full reference information on the Get Customs Documents endpoint, see the Get Customs Documents page of the API reference.
- For a user guide on retrieving customs documents and commercial invoices in Ship, see the Getting Customs Docs and Invoices page.
Get Customs Documents Example
This example shows a Get Customs Documents response for a single-package consignment. Ship has returned a commercial invoice for the consignment and a CN22 document for the package.
You will need to decode the file's Base64 data in order to view or print the documents. If you are unsure how to do so, see the MDN docs for more information.
GET https://api.electioapp.com/consignments/docs/EC-000-05B-MMA
Step 5: Manifesting a Consignment
PUT https://api.electioapp.com/consignments/manifestFromQuery
Once you've created a consignment, allocated it to a carrier service and printed labels for it, you're ready to manifest it. To manifest a consignment, use the Manifest Consignments From Query endpoint. In the context of Ship, the term "manifesting" refers to collating, formatting and transmitting the consignment data to carriers.
The Manifest Consignments From Query endpoint enables you to use a query to select consignments to be manifested. Once Ship has added those consignments to a manifest and queued the data to be sent, the Manifest Consignments From Query endpoint returns a Message detailing how many consignments met the terms of the query, how many of those consignments were successfully queued, and how many could not be queued.
Note
- For full reference information on the Manifest Consignments From Query endpoint, see the Manifest Consignments From Query page of the API Reference.
- For a user guide on manifesting consignments, see the Manifesting Consignments page.
Manifest Consignments From Query Example
The example shows a request to manifest all consignments that are allocated to Carrier X, shipping from a location with the ShippingLocationReference Location1, and have already had their labels printed. The response indicates that Ship found 10 consignments meeting these criteria, and that all 10 were successfully queued for manifest.
PUT https://api.electioapp.com/consignments/manifestFromQuery
{
"ShippingLocationReferences": [
"Location1"
],
"States": [
"Allocated"
],
"Carriers": [
"CARRIER_X"
],
"LabelsPrinted": true
}