Import API (1.0)

Download OpenAPI specification:Download

Overview

Import jobs/orders to Localz.

There is a different set of APIs for Delivery / Field Services and for Collections. Please refer to the relevant section depending on your use case.

In each section there is also a set of APIs for async and sync.

async vs sync

async

These are asynchronous APIs that return a success response when Localz has received the instruction to import the jobs/orders, but it is not a guarantee that all have been imported successfully. There may be some errors downstream. A callback URL can be configured to notify if any of these downstream errros occur. Please contact Localz to configure this callback if you are using the async APIs.

sync

These are synchronous APIs that wait for all downstream systems to do their work, and return any errors in the response.

Should I use async or sync?

If importing small batches it's generally recommended to use sync - all errors are returned in the response and you don't have to worry about callbacks. But for larger batches async is recommended. Please consult with Localz to confirm the best approach for your use case.

Delivery - async

Import Jobs

Import new jobs

Authorizations:

ApiKeyAuth

path Parameters

projectId

required

string

Project ID

Request Body schema: application/json

Jobs

required

Array of objects (request.JobWithDriver)

Responses

Request samples

Payload

Content type

application/json

{"jobs": [{"address": {"country": "Australia",
"countryCode": "AU",
"geoJson": {"coordinates": [144.4913965,
-37.9701481
],
"type": "Point"
},
"locality": "Melbourne",
"postcode": "3000",
"region": "VIC",
"streetAddress": "412 Collins St",
"subStreetAddress": "Level 9"
},
"attributes": { },
"branchId": "1000",
"cancelledAdditionalInfo": "customer not home",
"cancelledReasonCode": "postponed",
"commsChannels": ["email"
],
"commsOptOut": true,
"customer": {"email": "test@example.com",
"firstName": "Margie",
"id": "123",
"lastName": "Moon",
"phone": "+64200000000",
"title": "Mr"
},
"customerInstructions": ["string"
],
"deliveryDate": "2020-10-04T23:45:01+00:00",
"deliveryType": "Standard Delivery",
"driver": {"deviceId": "pat-postie-device",
"employeeId": "employee-123",
"firstName": "Pat",
"lastName": "Postie",
"phone": "+64200000000"
},
"fulfiller": "fastpost",
"id": "order123",
"isPriority": true,
"jobItems": [{"attributes": { },
"jobItemId": "qwe12",
"price": 0,
"quantity": 0,
"status": "PENDING",
"stockCode": "string",
"stockName": "string",
"subItems": [{"attributes": { },
"id": "SerialNumber1"
}
]
}
],
"langCode": "en",
"media": [{"attributes": [{"key": "name",
"value": "v1 Pdf File"
}
],
"identifier": "id1",
"mimetype": "application/pdf",
"uri": "media://aaa/bbb.pdf"
}
],
"nominees": [{"email": "test@example.com",
"firstName": "Nina",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
}
],
"plannedEta": "2020-10-04T23:45:01+00:00",
"plannedEtaWindow": {"etaFrom": "2020-10-04T23:45:01+00:00",
"etaTo": "2020-10-04T23:45:01+00:00"
},
"scheduleStatus": "CUSTOMER_PENDING",
"secondaryReference": "order3",
"sequence": 1,
"status": "PENDING",
"stopId": "string",
"subProjectId": "mybrand",
"tags": ["string"
],
"trackingId": "track123",
"waitTime": 240
}
]
}

Response samples

200
400
401
500

Content type

application/json

{"failed": [{"id": "string",
"reason": "string"
}
],
"jobs": [{"orderNumber": "string",
"subProjectId": "string",
"trackingId": "string"
}
],
"jobsReceived": 0
}

Batch Update Jobs

Perform a batch update of jobs

Authorizations:

ApiKeyAuth

path Parameters

projectId

required

string

Project ID

Request Body schema: application/json

Jobs

required

Array of objects (request.UpdateJob)

Responses

Request samples

Payload

Content type

application/json

{"jobs": [{"address": {"country": "Australia",
"countryCode": "AU",
"geoJson": {"coordinates": [144.4913965,
-37.9701481
],
"type": "Point"
},
"locality": "Melbourne",
"postcode": "3000",
"region": "VIC",
"streetAddress": "412 Collins St",
"subStreetAddress": "Level 9"
},
"attributes": { },
"branchId": "1000",
"cancelledAdditionalInfo": "customer not home",
"cancelledReasonCode": "postponed",
"commsChannels": ["email"
],
"commsOptOut": true,
"customer": {"email": "test@example.com",
"firstName": "Margie",
"id": "123",
"lastName": "Moon",
"phone": "+64200000000",
"title": "Mr"
},
"customerInstructions": ["string"
],
"deliveryDate": "string",
"deliveryType": "Standard Delivery",
"driver": {"deviceId": "pat-postie-device",
"employeeId": "employee-123",
"firstName": "Pat",
"lastName": "Postie",
"phone": "+64200000000"
},
"fulfiller": "fastpost",
"id": "string",
"isPriority": true,
"jobItems": [{"attributes": { },
"jobItemId": "qwe12",
"price": 0,
"quantity": 0,
"status": "PENDING",
"stockCode": "string",
"stockName": "string",
"subItems": [{"attributes": { },
"id": "SerialNumber1"
}
]
}
],
"langCode": "en",
"media": [{"attributes": [{"key": "name",
"value": "v1 Pdf File"
}
],
"identifier": "id1",
"mimetype": "application/pdf",
"uri": "media://aaa/bbb.pdf"
}
],
"nominees": [{"email": "test@example.com",
"firstName": "Nina",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
}
],
"plannedEta": "string",
"plannedEtaWindow": {"etaFrom": "2020-10-04T23:45:01+00:00",
"etaTo": "2020-10-04T23:45:01+00:00"
},
"proofOfDelivery": [{"contentType": "image",
"name": "signature",
"value": "http://example.com/signature"
}
],
"scheduleStatus": "CUSTOMER_PENDING",
"secondaryReference": "string",
"sequence": 0,
"status": "PENDING",
"stopId": "string",
"subProjectId": "mybrand",
"tags": ["string"
],
"waitTime": 0
}
]
}

Response samples

200
400
401
500

Content type

application/json

{"failed": [{"id": "string",
"reason": "string"
}
],
"jobs": [{"orderNumber": "string",
"subProjectId": "string",
"trackingId": "string"
}
],
"jobsReceived": 0
}

Update Job

Update a job

Authorizations:

ApiKeyAuth

path Parameters

projectId required	string Project ID
jobId required	string Job ID

Request Body schema: application/json

Job

	object (request.Address)
	object
branchId	string
cancelledAdditionalInfo	string
cancelledReasonCode	string
commsChannels	Array of strings Items Enum: "email" "sms" "voiceCall" "push" "whatsapp" "rcs"
commsOptOut	boolean
	object (github_com_dsg-localz_delivery-import-api_internal_deliveries_request.Customer)
customerInstructions	Array of strings
deliveryDate	string
deliveryType	string
	object (request.NillableDriver) Driver object - if explicitly set to null then the current driver will be unassigned
fulfiller	string
id	string
isPriority	boolean
	Array of objects (request.JobItem)
langCode	string language code as per ISO-639-1
	Array of objects (github_com_dsg-localz_delivery-import-api_internal_deliveries_request.Media)
	Array of objects (github_com_dsg-localz_delivery-import-api_internal_deliveries_request.Nominee)
plannedEta	string
	object (request.PlannedETAWindow)
	Array of objects (request.ProofOfDelivery) only allowed when Status is DELIVERED or UNDELIVERED
scheduleStatus	string Value: "CUSTOMER_PENDING CANCELLED_PENDING CONFIRMED RESCHEDULED SCHEDULED UNSCHEDULED"
secondaryReference	string
sequence	integer
status required	string Enum: "PENDING" "PENDING_PICKED" "PENDING_PACKED" "DISPATCH" "ARRIVING" "CANCELLED" "DELIVERED" "UNDELIVERED"
stopId	string
subProjectId	string if set, will override any subProjectId in the URL
tags	Array of strings
waitTime	integer

Responses

Request samples

Payload

Content type

application/json

{"address": {"country": "Australia",
"countryCode": "AU",
"geoJson": {"coordinates": [144.4913965,
-37.9701481
],
"type": "Point"
},
"locality": "Melbourne",
"postcode": "3000",
"region": "VIC",
"streetAddress": "412 Collins St",
"subStreetAddress": "Level 9"
},
"attributes": { },
"branchId": "1000",
"cancelledAdditionalInfo": "customer not home",
"cancelledReasonCode": "postponed",
"commsChannels": ["email"
],
"commsOptOut": true,
"customer": {"email": "test@example.com",
"firstName": "Margie",
"id": "123",
"lastName": "Moon",
"phone": "+64200000000",
"title": "Mr"
},
"customerInstructions": ["string"
],
"deliveryDate": "string",
"deliveryType": "Standard Delivery",
"driver": {"deviceId": "pat-postie-device",
"employeeId": "employee-123",
"firstName": "Pat",
"lastName": "Postie",
"phone": "+64200000000"
},
"fulfiller": "fastpost",
"id": "string",
"isPriority": true,
"jobItems": [{"attributes": { },
"jobItemId": "qwe12",
"price": 0,
"quantity": 0,
"status": "PENDING",
"stockCode": "string",
"stockName": "string",
"subItems": [{"attributes": { },
"id": "SerialNumber1"
}
]
}
],
"langCode": "en",
"media": [{"attributes": [{"key": "name",
"value": "v1 Pdf File"
}
],
"identifier": "id1",
"mimetype": "application/pdf",
"uri": "media://aaa/bbb.pdf"
}
],
"nominees": [{"email": "test@example.com",
"firstName": "Nina",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
}
],
"plannedEta": "string",
"plannedEtaWindow": {"etaFrom": "2020-10-04T23:45:01+00:00",
"etaTo": "2020-10-04T23:45:01+00:00"
},
"proofOfDelivery": [{"contentType": "image",
"name": "signature",
"value": "http://example.com/signature"
}
],
"scheduleStatus": "CUSTOMER_PENDING",
"secondaryReference": "string",
"sequence": 0,
"status": "PENDING",
"stopId": "string",
"subProjectId": "mybrand",
"tags": ["string"
],
"waitTime": 0
}

Response samples

200
400
401
500

Content type

application/json

{"failed": [{"id": "string",
"reason": "string"
}
],
"jobs": [{"orderNumber": "string",
"subProjectId": "string",
"trackingId": "string"
}
],
"jobsReceived": 0
}

Import Routes

Import new routes

Authorizations:

ApiKeyAuth

path Parameters

projectId

required

string

Project ID

Request Body schema: application/json

Routes

required

Array of objects (request.Route)

Responses

Request samples

Payload

Content type

application/json

{"routes": [{"driver": {"deviceId": "pat-postie-device",
"employeeId": "employee-123",
"firstName": "Pat",
"lastName": "Postie",
"phone": "+64200000000"
},
"id": "route1",
"jobs": [{"address": {"country": "Australia",
"countryCode": "AU",
"geoJson": {"coordinates": [144.4913965,
-37.9701481
],
"type": "Point"
},
"locality": "Melbourne",
"postcode": "3000",
"region": "VIC",
"streetAddress": "412 Collins St",
"subStreetAddress": "Level 9"
},
"attributes": { },
"branchId": "1000",
"cancelledAdditionalInfo": "customer not home",
"cancelledReasonCode": "postponed",
"commsChannels": ["email"
],
"commsOptOut": true,
"customer": {"email": "test@example.com",
"firstName": "Margie",
"id": "123",
"lastName": "Moon",
"phone": "+64200000000",
"title": "Mr"
},
"customerInstructions": ["string"
],
"deliveryType": "Standard Delivery",
"fulfiller": "fastpost",
"id": "order123",
"isPriority": true,
"jobItems": [{"attributes": { },
"jobItemId": "qwe12",
"price": 0,
"quantity": 0,
"status": "PENDING",
"stockCode": "string",
"stockName": "string",
"subItems": [{"attributes": { },
"id": "SerialNumber1"
}
]
}
],
"langCode": "en",
"media": [{"attributes": [{"key": "name",
"value": "v1 Pdf File"
}
],
"identifier": "id1",
"mimetype": "application/pdf",
"uri": "media://aaa/bbb.pdf"
}
],
"nominees": [{"email": "test@example.com",
"firstName": "Nina",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
}
],
"plannedEta": "2020-10-04T23:45:01+00:00",
"plannedEtaWindow": {"etaFrom": "2020-10-04T23:45:01+00:00",
"etaTo": "2020-10-04T23:45:01+00:00"
},
"scheduleStatus": "CUSTOMER_PENDING",
"secondaryReference": "order3",
"sequence": 1,
"status": "PENDING",
"stopId": "string",
"subProjectId": "mybrand",
"tags": ["string"
],
"trackingId": "track123",
"waitTime": 240
}
],
"routeDate": "2020-10-04T23:45:01+00:00"
}
]
}

Response samples

200
400
401
500

Content type

application/json

{"failed": [{"id": "string",
"reason": "string"
}
],
"jobs": [{"orderNumber": "string",
"subProjectId": "string",
"trackingId": "string"
}
],
"jobsReceived": 0
}

Import Jobs (Multibrand)

Import new jobs for a particular subproject

Authorizations:

ApiKeyAuth

path Parameters

projectId required	string Project ID
subProjectId required	string SubProject ID

Request Body schema: application/json

Jobs

required

Array of objects (request.JobWithDriver)

Responses

Request samples

Payload

Content type

application/json

{"jobs": [{"address": {"country": "Australia",
"countryCode": "AU",
"geoJson": {"coordinates": [144.4913965,
-37.9701481
],
"type": "Point"
},
"locality": "Melbourne",
"postcode": "3000",
"region": "VIC",
"streetAddress": "412 Collins St",
"subStreetAddress": "Level 9"
},
"attributes": { },
"branchId": "1000",
"cancelledAdditionalInfo": "customer not home",
"cancelledReasonCode": "postponed",
"commsChannels": ["email"
],
"commsOptOut": true,
"customer": {"email": "test@example.com",
"firstName": "Margie",
"id": "123",
"lastName": "Moon",
"phone": "+64200000000",
"title": "Mr"
},
"customerInstructions": ["string"
],
"deliveryDate": "2020-10-04T23:45:01+00:00",
"deliveryType": "Standard Delivery",
"driver": {"deviceId": "pat-postie-device",
"employeeId": "employee-123",
"firstName": "Pat",
"lastName": "Postie",
"phone": "+64200000000"
},
"fulfiller": "fastpost",
"id": "order123",
"isPriority": true,
"jobItems": [{"attributes": { },
"jobItemId": "qwe12",
"price": 0,
"quantity": 0,
"status": "PENDING",
"stockCode": "string",
"stockName": "string",
"subItems": [{"attributes": { },
"id": "SerialNumber1"
}
]
}
],
"langCode": "en",
"media": [{"attributes": [{"key": "name",
"value": "v1 Pdf File"
}
],
"identifier": "id1",
"mimetype": "application/pdf",
"uri": "media://aaa/bbb.pdf"
}
],
"nominees": [{"email": "test@example.com",
"firstName": "Nina",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
}
],
"plannedEta": "2020-10-04T23:45:01+00:00",
"plannedEtaWindow": {"etaFrom": "2020-10-04T23:45:01+00:00",
"etaTo": "2020-10-04T23:45:01+00:00"
},
"scheduleStatus": "CUSTOMER_PENDING",
"secondaryReference": "order3",
"sequence": 1,
"status": "PENDING",
"stopId": "string",
"subProjectId": "mybrand",
"tags": ["string"
],
"trackingId": "track123",
"waitTime": 240
}
]
}

Response samples

200
400
401
500

Content type

application/json

{"failed": [{"id": "string",
"reason": "string"
}
],
"jobs": [{"orderNumber": "string",
"subProjectId": "string",
"trackingId": "string"
}
],
"jobsReceived": 0
}

Batch Update Jobs (Multibrand)

Perform a batch update of jobs for a particular subproject

Authorizations:

ApiKeyAuth

path Parameters

projectId required	string Project ID
subProjectId required	string SubProject ID

Request Body schema: application/json

Jobs

required

Array of objects (request.UpdateJob)

Responses

Request samples

Payload

Content type

application/json

{"jobs": [{"address": {"country": "Australia",
"countryCode": "AU",
"geoJson": {"coordinates": [144.4913965,
-37.9701481
],
"type": "Point"
},
"locality": "Melbourne",
"postcode": "3000",
"region": "VIC",
"streetAddress": "412 Collins St",
"subStreetAddress": "Level 9"
},
"attributes": { },
"branchId": "1000",
"cancelledAdditionalInfo": "customer not home",
"cancelledReasonCode": "postponed",
"commsChannels": ["email"
],
"commsOptOut": true,
"customer": {"email": "test@example.com",
"firstName": "Margie",
"id": "123",
"lastName": "Moon",
"phone": "+64200000000",
"title": "Mr"
},
"customerInstructions": ["string"
],
"deliveryDate": "string",
"deliveryType": "Standard Delivery",
"driver": {"deviceId": "pat-postie-device",
"employeeId": "employee-123",
"firstName": "Pat",
"lastName": "Postie",
"phone": "+64200000000"
},
"fulfiller": "fastpost",
"id": "string",
"isPriority": true,
"jobItems": [{"attributes": { },
"jobItemId": "qwe12",
"price": 0,
"quantity": 0,
"status": "PENDING",
"stockCode": "string",
"stockName": "string",
"subItems": [{"attributes": { },
"id": "SerialNumber1"
}
]
}
],
"langCode": "en",
"media": [{"attributes": [{"key": "name",
"value": "v1 Pdf File"
}
],
"identifier": "id1",
"mimetype": "application/pdf",
"uri": "media://aaa/bbb.pdf"
}
],
"nominees": [{"email": "test@example.com",
"firstName": "Nina",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
}
],
"plannedEta": "string",
"plannedEtaWindow": {"etaFrom": "2020-10-04T23:45:01+00:00",
"etaTo": "2020-10-04T23:45:01+00:00"
},
"proofOfDelivery": [{"contentType": "image",
"name": "signature",
"value": "http://example.com/signature"
}
],
"scheduleStatus": "CUSTOMER_PENDING",
"secondaryReference": "string",
"sequence": 0,
"status": "PENDING",
"stopId": "string",
"subProjectId": "mybrand",
"tags": ["string"
],
"waitTime": 0
}
]
}

Response samples

200
400
401
500

Content type

application/json

{"failed": [{"id": "string",
"reason": "string"
}
],
"jobs": [{"orderNumber": "string",
"subProjectId": "string",
"trackingId": "string"
}
],
"jobsReceived": 0
}

Update Job (Multibrand)

Update a job for a particular subproject

Authorizations:

ApiKeyAuth

path Parameters

projectId required	string Project ID
subProjectId required	string SubProject ID
jobId required	string Job ID

Request Body schema: application/json

Job

	object (request.Address)
	object
branchId	string
cancelledAdditionalInfo	string
cancelledReasonCode	string
commsChannels	Array of strings Items Enum: "email" "sms" "voiceCall" "push" "whatsapp" "rcs"
commsOptOut	boolean
	object (github_com_dsg-localz_delivery-import-api_internal_deliveries_request.Customer)
customerInstructions	Array of strings
deliveryDate	string
deliveryType	string
	object (request.NillableDriver) Driver object - if explicitly set to null then the current driver will be unassigned
fulfiller	string
id	string
isPriority	boolean
	Array of objects (request.JobItem)
langCode	string language code as per ISO-639-1
	Array of objects (github_com_dsg-localz_delivery-import-api_internal_deliveries_request.Media)
	Array of objects (github_com_dsg-localz_delivery-import-api_internal_deliveries_request.Nominee)
plannedEta	string
	object (request.PlannedETAWindow)
	Array of objects (request.ProofOfDelivery) only allowed when Status is DELIVERED or UNDELIVERED
scheduleStatus	string Value: "CUSTOMER_PENDING CANCELLED_PENDING CONFIRMED RESCHEDULED SCHEDULED UNSCHEDULED"
secondaryReference	string
sequence	integer
status required	string Enum: "PENDING" "PENDING_PICKED" "PENDING_PACKED" "DISPATCH" "ARRIVING" "CANCELLED" "DELIVERED" "UNDELIVERED"
stopId	string
subProjectId	string if set, will override any subProjectId in the URL
tags	Array of strings
waitTime	integer

Responses

Request samples

Payload

Content type

application/json

{"address": {"country": "Australia",
"countryCode": "AU",
"geoJson": {"coordinates": [144.4913965,
-37.9701481
],
"type": "Point"
},
"locality": "Melbourne",
"postcode": "3000",
"region": "VIC",
"streetAddress": "412 Collins St",
"subStreetAddress": "Level 9"
},
"attributes": { },
"branchId": "1000",
"cancelledAdditionalInfo": "customer not home",
"cancelledReasonCode": "postponed",
"commsChannels": ["email"
],
"commsOptOut": true,
"customer": {"email": "test@example.com",
"firstName": "Margie",
"id": "123",
"lastName": "Moon",
"phone": "+64200000000",
"title": "Mr"
},
"customerInstructions": ["string"
],
"deliveryDate": "string",
"deliveryType": "Standard Delivery",
"driver": {"deviceId": "pat-postie-device",
"employeeId": "employee-123",
"firstName": "Pat",
"lastName": "Postie",
"phone": "+64200000000"
},
"fulfiller": "fastpost",
"id": "string",
"isPriority": true,
"jobItems": [{"attributes": { },
"jobItemId": "qwe12",
"price": 0,
"quantity": 0,
"status": "PENDING",
"stockCode": "string",
"stockName": "string",
"subItems": [{"attributes": { },
"id": "SerialNumber1"
}
]
}
],
"langCode": "en",
"media": [{"attributes": [{"key": "name",
"value": "v1 Pdf File"
}
],
"identifier": "id1",
"mimetype": "application/pdf",
"uri": "media://aaa/bbb.pdf"
}
],
"nominees": [{"email": "test@example.com",
"firstName": "Nina",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
}
],
"plannedEta": "string",
"plannedEtaWindow": {"etaFrom": "2020-10-04T23:45:01+00:00",
"etaTo": "2020-10-04T23:45:01+00:00"
},
"proofOfDelivery": [{"contentType": "image",
"name": "signature",
"value": "http://example.com/signature"
}
],
"scheduleStatus": "CUSTOMER_PENDING",
"secondaryReference": "string",
"sequence": 0,
"status": "PENDING",
"stopId": "string",
"subProjectId": "mybrand",
"tags": ["string"
],
"waitTime": 0
}

Response samples

200
400
401
500

Content type

application/json

{"failed": [{"id": "string",
"reason": "string"
}
],
"jobs": [{"orderNumber": "string",
"subProjectId": "string",
"trackingId": "string"
}
],
"jobsReceived": 0
}

Import Routes (Multibrand)

Import new routes for a particular subproject

Authorizations:

ApiKeyAuth

path Parameters

projectId required	string Project ID
subProjectId required	string SubProject ID

Request Body schema: application/json

Routes

required

Array of objects (request.Route)

Responses

Request samples

Payload

Content type

application/json

{"routes": [{"driver": {"deviceId": "pat-postie-device",
"employeeId": "employee-123",
"firstName": "Pat",
"lastName": "Postie",
"phone": "+64200000000"
},
"id": "route1",
"jobs": [{"address": {"country": "Australia",
"countryCode": "AU",
"geoJson": {"coordinates": [144.4913965,
-37.9701481
],
"type": "Point"
},
"locality": "Melbourne",
"postcode": "3000",
"region": "VIC",
"streetAddress": "412 Collins St",
"subStreetAddress": "Level 9"
},
"attributes": { },
"branchId": "1000",
"cancelledAdditionalInfo": "customer not home",
"cancelledReasonCode": "postponed",
"commsChannels": ["email"
],
"commsOptOut": true,
"customer": {"email": "test@example.com",
"firstName": "Margie",
"id": "123",
"lastName": "Moon",
"phone": "+64200000000",
"title": "Mr"
},
"customerInstructions": ["string"
],
"deliveryType": "Standard Delivery",
"fulfiller": "fastpost",
"id": "order123",
"isPriority": true,
"jobItems": [{"attributes": { },
"jobItemId": "qwe12",
"price": 0,
"quantity": 0,
"status": "PENDING",
"stockCode": "string",
"stockName": "string",
"subItems": [{"attributes": { },
"id": "SerialNumber1"
}
]
}
],
"langCode": "en",
"media": [{"attributes": [{"key": "name",
"value": "v1 Pdf File"
}
],
"identifier": "id1",
"mimetype": "application/pdf",
"uri": "media://aaa/bbb.pdf"
}
],
"nominees": [{"email": "test@example.com",
"firstName": "Nina",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
}
],
"plannedEta": "2020-10-04T23:45:01+00:00",
"plannedEtaWindow": {"etaFrom": "2020-10-04T23:45:01+00:00",
"etaTo": "2020-10-04T23:45:01+00:00"
},
"scheduleStatus": "CUSTOMER_PENDING",
"secondaryReference": "order3",
"sequence": 1,
"status": "PENDING",
"stopId": "string",
"subProjectId": "mybrand",
"tags": ["string"
],
"trackingId": "track123",
"waitTime": 240
}
],
"routeDate": "2020-10-04T23:45:01+00:00"
}
]
}

Response samples

200
400
401
500

Content type

application/json

{"failed": [{"id": "string",
"reason": "string"
}
],
"jobs": [{"orderNumber": "string",
"subProjectId": "string",
"trackingId": "string"
}
],
"jobsReceived": 0
}

Delivery - sync

Create jobs

Create batch of jobs in a single request

Authorizations:

ApiKeyAuth

path Parameters

projectId

required

string

Project ID

Request Body schema: application/json

Jobs

required

Array of objects (request.JobWithDriver)

Responses

Request samples

Payload

Content type

application/json

{"jobs": [{"address": {"country": "Australia",
"countryCode": "AU",
"geoJson": {"coordinates": [144.4913965,
-37.9701481
],
"type": "Point"
},
"locality": "Melbourne",
"postcode": "3000",
"region": "VIC",
"streetAddress": "412 Collins St",
"subStreetAddress": "Level 9"
},
"attributes": { },
"branchId": "1000",
"cancelledAdditionalInfo": "customer not home",
"cancelledReasonCode": "postponed",
"commsChannels": ["email"
],
"commsOptOut": true,
"customer": {"email": "test@example.com",
"firstName": "Margie",
"id": "123",
"lastName": "Moon",
"phone": "+64200000000",
"title": "Mr"
},
"customerInstructions": ["string"
],
"deliveryDate": "2020-10-04T23:45:01+00:00",
"deliveryType": "Standard Delivery",
"driver": {"deviceId": "pat-postie-device",
"employeeId": "employee-123",
"firstName": "Pat",
"lastName": "Postie",
"phone": "+64200000000"
},
"fulfiller": "fastpost",
"id": "order123",
"isPriority": true,
"jobItems": [{"attributes": { },
"jobItemId": "qwe12",
"price": 0,
"quantity": 0,
"status": "PENDING",
"stockCode": "string",
"stockName": "string",
"subItems": [{"attributes": { },
"id": "SerialNumber1"
}
]
}
],
"langCode": "en",
"media": [{"attributes": [{"key": "name",
"value": "v1 Pdf File"
}
],
"identifier": "id1",
"mimetype": "application/pdf",
"uri": "media://aaa/bbb.pdf"
}
],
"nominees": [{"email": "test@example.com",
"firstName": "Nina",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
}
],
"plannedEta": "2020-10-04T23:45:01+00:00",
"plannedEtaWindow": {"etaFrom": "2020-10-04T23:45:01+00:00",
"etaTo": "2020-10-04T23:45:01+00:00"
},
"scheduleStatus": "CUSTOMER_PENDING",
"secondaryReference": "order3",
"sequence": 1,
"status": "PENDING",
"stopId": "string",
"subProjectId": "mybrand",
"tags": ["string"
],
"trackingId": "track123",
"waitTime": 240
}
]
}

Response samples

200
207
400
401
500

Content type

application/json

{"failed": [{"id": "string",
"reason": "string"
}
],
"jobs": [{"orderNumber": "string",
"subProjectId": "string",
"trackingId": "string"
}
],
"jobsReceived": 0
}

Update jobs

Update a batch of jobs in a single request

Authorizations:

ApiKeyAuth

path Parameters

projectId

required

string

Project ID

Request Body schema: application/json

Jobs

required

Array of objects (request.UpdateJob)

Responses

Request samples

Payload

Content type

application/json

{"jobs": [{"address": {"country": "Australia",
"countryCode": "AU",
"geoJson": {"coordinates": [144.4913965,
-37.9701481
],
"type": "Point"
},
"locality": "Melbourne",
"postcode": "3000",
"region": "VIC",
"streetAddress": "412 Collins St",
"subStreetAddress": "Level 9"
},
"attributes": { },
"branchId": "1000",
"cancelledAdditionalInfo": "customer not home",
"cancelledReasonCode": "postponed",
"commsChannels": ["email"
],
"commsOptOut": true,
"customer": {"email": "test@example.com",
"firstName": "Margie",
"id": "123",
"lastName": "Moon",
"phone": "+64200000000",
"title": "Mr"
},
"customerInstructions": ["string"
],
"deliveryDate": "string",
"deliveryType": "Standard Delivery",
"driver": {"deviceId": "pat-postie-device",
"employeeId": "employee-123",
"firstName": "Pat",
"lastName": "Postie",
"phone": "+64200000000"
},
"fulfiller": "fastpost",
"id": "string",
"isPriority": true,
"jobItems": [{"attributes": { },
"jobItemId": "qwe12",
"price": 0,
"quantity": 0,
"status": "PENDING",
"stockCode": "string",
"stockName": "string",
"subItems": [{"attributes": { },
"id": "SerialNumber1"
}
]
}
],
"langCode": "en",
"media": [{"attributes": [{"key": "name",
"value": "v1 Pdf File"
}
],
"identifier": "id1",
"mimetype": "application/pdf",
"uri": "media://aaa/bbb.pdf"
}
],
"nominees": [{"email": "test@example.com",
"firstName": "Nina",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
}
],
"plannedEta": "string",
"plannedEtaWindow": {"etaFrom": "2020-10-04T23:45:01+00:00",
"etaTo": "2020-10-04T23:45:01+00:00"
},
"proofOfDelivery": [{"contentType": "image",
"name": "signature",
"value": "http://example.com/signature"
}
],
"scheduleStatus": "CUSTOMER_PENDING",
"secondaryReference": "string",
"sequence": 0,
"status": "PENDING",
"stopId": "string",
"subProjectId": "mybrand",
"tags": ["string"
],
"waitTime": 0
}
]
}

Response samples

200
207
400
401
500

Content type

application/json

{"failed": [{"id": "string",
"reason": "string"
}
],
"jobs": [{"orderNumber": "string",
"subProjectId": "string",
"trackingId": "string"
}
],
"jobsReceived": 0
}

Create routes

Create batch of routes in a single request

Authorizations:

ApiKeyAuth

path Parameters

projectId

required

string

Project ID

Request Body schema: application/json

Routes

required

Array of objects (request.Route)

Responses

Request samples

Payload

Content type

application/json

{"routes": [{"driver": {"deviceId": "pat-postie-device",
"employeeId": "employee-123",
"firstName": "Pat",
"lastName": "Postie",
"phone": "+64200000000"
},
"id": "route1",
"jobs": [{"address": {"country": "Australia",
"countryCode": "AU",
"geoJson": {"coordinates": [144.4913965,
-37.9701481
],
"type": "Point"
},
"locality": "Melbourne",
"postcode": "3000",
"region": "VIC",
"streetAddress": "412 Collins St",
"subStreetAddress": "Level 9"
},
"attributes": { },
"branchId": "1000",
"cancelledAdditionalInfo": "customer not home",
"cancelledReasonCode": "postponed",
"commsChannels": ["email"
],
"commsOptOut": true,
"customer": {"email": "test@example.com",
"firstName": "Margie",
"id": "123",
"lastName": "Moon",
"phone": "+64200000000",
"title": "Mr"
},
"customerInstructions": ["string"
],
"deliveryType": "Standard Delivery",
"fulfiller": "fastpost",
"id": "order123",
"isPriority": true,
"jobItems": [{"attributes": { },
"jobItemId": "qwe12",
"price": 0,
"quantity": 0,
"status": "PENDING",
"stockCode": "string",
"stockName": "string",
"subItems": [{"attributes": { },
"id": "SerialNumber1"
}
]
}
],
"langCode": "en",
"media": [{"attributes": [{"key": "name",
"value": "v1 Pdf File"
}
],
"identifier": "id1",
"mimetype": "application/pdf",
"uri": "media://aaa/bbb.pdf"
}
],
"nominees": [{"email": "test@example.com",
"firstName": "Nina",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
}
],
"plannedEta": "2020-10-04T23:45:01+00:00",
"plannedEtaWindow": {"etaFrom": "2020-10-04T23:45:01+00:00",
"etaTo": "2020-10-04T23:45:01+00:00"
},
"scheduleStatus": "CUSTOMER_PENDING",
"secondaryReference": "order3",
"sequence": 1,
"status": "PENDING",
"stopId": "string",
"subProjectId": "mybrand",
"tags": ["string"
],
"trackingId": "track123",
"waitTime": 240
}
],
"routeDate": "2020-10-04T23:45:01+00:00"
}
]
}

Response samples

200
207
400
401
500

Content type

application/json

{"failed": [{"id": "string",
"reason": "string"
}
],
"jobs": [{"orderNumber": "string",
"subProjectId": "string",
"trackingId": "string"
}
],
"jobsReceived": 0
}

Create job

Create new job

Authorizations:

ApiKeyAuth

path Parameters

projectId

required

string

Project ID

Request Body schema: application/json

Job

required	object (request.Address)
	object
branchId	string
cancelledAdditionalInfo	string
cancelledReasonCode	string
commsChannels	Array of strings Items Enum: "email" "sms" "voiceCall" "push" "whatsapp" "rcs"
commsOptOut	boolean
	object (github_com_dsg-localz_delivery-import-api_internal_deliveries_request.Customer)
customerInstructions	Array of strings
deliveryDate	string defaults to now if not provided
deliveryType	string
	object (request.NillableDriver) Driver object - if explicitly set to null then the current driver will be unassigned
fulfiller	string
id required	string
isPriority	boolean
	Array of objects (request.JobItem)
langCode	string language code as per ISO-639-1
	Array of objects (github_com_dsg-localz_delivery-import-api_internal_deliveries_request.Media)
	Array of objects (github_com_dsg-localz_delivery-import-api_internal_deliveries_request.Nominee)
plannedEta	string
	object (request.PlannedETAWindow)
scheduleStatus	string Value: "CUSTOMER_PENDING CANCELLED_PENDING CONFIRMED RESCHEDULED SCHEDULED UNSCHEDULED"
secondaryReference	string
sequence	integer
status required	string Enum: "PENDING" "PENDING_PICKED" "PENDING_PACKED" "READY" "DISPATCH" "ARRIVING" "CANCELLED" "DELIVERED" "UNDELIVERED"
stopId	string
subProjectId	string if set, will override any subProjectId in the URL
tags	Array of strings
trackingId	string
waitTime	integer

Responses

Request samples

Payload

Content type

application/json

{"address": {"country": "Australia",
"countryCode": "AU",
"geoJson": {"coordinates": [144.4913965,
-37.9701481
],
"type": "Point"
},
"locality": "Melbourne",
"postcode": "3000",
"region": "VIC",
"streetAddress": "412 Collins St",
"subStreetAddress": "Level 9"
},
"attributes": { },
"branchId": "1000",
"cancelledAdditionalInfo": "customer not home",
"cancelledReasonCode": "postponed",
"commsChannels": ["email"
],
"commsOptOut": true,
"customer": {"email": "test@example.com",
"firstName": "Margie",
"id": "123",
"lastName": "Moon",
"phone": "+64200000000",
"title": "Mr"
},
"customerInstructions": ["string"
],
"deliveryDate": "2020-10-04T23:45:01+00:00",
"deliveryType": "Standard Delivery",
"driver": {"deviceId": "pat-postie-device",
"employeeId": "employee-123",
"firstName": "Pat",
"lastName": "Postie",
"phone": "+64200000000"
},
"fulfiller": "fastpost",
"id": "order123",
"isPriority": true,
"jobItems": [{"attributes": { },
"jobItemId": "qwe12",
"price": 0,
"quantity": 0,
"status": "PENDING",
"stockCode": "string",
"stockName": "string",
"subItems": [{"attributes": { },
"id": "SerialNumber1"
}
]
}
],
"langCode": "en",
"media": [{"attributes": [{"key": "name",
"value": "v1 Pdf File"
}
],
"identifier": "id1",
"mimetype": "application/pdf",
"uri": "media://aaa/bbb.pdf"
}
],
"nominees": [{"email": "test@example.com",
"firstName": "Nina",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
}
],
"plannedEta": "2020-10-04T23:45:01+00:00",
"plannedEtaWindow": {"etaFrom": "2020-10-04T23:45:01+00:00",
"etaTo": "2020-10-04T23:45:01+00:00"
},
"scheduleStatus": "CUSTOMER_PENDING",
"secondaryReference": "order3",
"sequence": 1,
"status": "PENDING",
"stopId": "string",
"subProjectId": "mybrand",
"tags": ["string"
],
"trackingId": "track123",
"waitTime": 240
}

Response samples

400
401
500

Content type

application/json

{"message": "string"
}

Update job

Update a job

Authorizations:

ApiKeyAuth

path Parameters

projectId

required

string

Project ID

Request Body schema: application/json

Jobs

	object (request.Address)
	object
branchId	string
cancelledAdditionalInfo	string
cancelledReasonCode	string
commsChannels	Array of strings Items Enum: "email" "sms" "voiceCall" "push" "whatsapp" "rcs"
commsOptOut	boolean
	object (github_com_dsg-localz_delivery-import-api_internal_deliveries_request.Customer)
customerInstructions	Array of strings
deliveryDate	string
deliveryType	string
	object (request.NillableDriver) Driver object - if explicitly set to null then the current driver will be unassigned
fulfiller	string
id	string
isPriority	boolean
	Array of objects (request.JobItem)
langCode	string language code as per ISO-639-1
	Array of objects (github_com_dsg-localz_delivery-import-api_internal_deliveries_request.Media)
	Array of objects (github_com_dsg-localz_delivery-import-api_internal_deliveries_request.Nominee)
plannedEta	string
	object (request.PlannedETAWindow)
	Array of objects (request.ProofOfDelivery) only allowed when Status is DELIVERED or UNDELIVERED
scheduleStatus	string Value: "CUSTOMER_PENDING CANCELLED_PENDING CONFIRMED RESCHEDULED SCHEDULED UNSCHEDULED"
secondaryReference	string
sequence	integer
status required	string Enum: "PENDING" "PENDING_PICKED" "PENDING_PACKED" "DISPATCH" "ARRIVING" "CANCELLED" "DELIVERED" "UNDELIVERED"
stopId	string
subProjectId	string if set, will override any subProjectId in the URL
tags	Array of strings
waitTime	integer

Responses

Request samples

Payload

Content type

application/json

{"address": {"country": "Australia",
"countryCode": "AU",
"geoJson": {"coordinates": [144.4913965,
-37.9701481
],
"type": "Point"
},
"locality": "Melbourne",
"postcode": "3000",
"region": "VIC",
"streetAddress": "412 Collins St",
"subStreetAddress": "Level 9"
},
"attributes": { },
"branchId": "1000",
"cancelledAdditionalInfo": "customer not home",
"cancelledReasonCode": "postponed",
"commsChannels": ["email"
],
"commsOptOut": true,
"customer": {"email": "test@example.com",
"firstName": "Margie",
"id": "123",
"lastName": "Moon",
"phone": "+64200000000",
"title": "Mr"
},
"customerInstructions": ["string"
],
"deliveryDate": "string",
"deliveryType": "Standard Delivery",
"driver": {"deviceId": "pat-postie-device",
"employeeId": "employee-123",
"firstName": "Pat",
"lastName": "Postie",
"phone": "+64200000000"
},
"fulfiller": "fastpost",
"id": "string",
"isPriority": true,
"jobItems": [{"attributes": { },
"jobItemId": "qwe12",
"price": 0,
"quantity": 0,
"status": "PENDING",
"stockCode": "string",
"stockName": "string",
"subItems": [{"attributes": { },
"id": "SerialNumber1"
}
]
}
],
"langCode": "en",
"media": [{"attributes": [{"key": "name",
"value": "v1 Pdf File"
}
],
"identifier": "id1",
"mimetype": "application/pdf",
"uri": "media://aaa/bbb.pdf"
}
],
"nominees": [{"email": "test@example.com",
"firstName": "Nina",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
}
],
"plannedEta": "string",
"plannedEtaWindow": {"etaFrom": "2020-10-04T23:45:01+00:00",
"etaTo": "2020-10-04T23:45:01+00:00"
},
"proofOfDelivery": [{"contentType": "image",
"name": "signature",
"value": "http://example.com/signature"
}
],
"scheduleStatus": "CUSTOMER_PENDING",
"secondaryReference": "string",
"sequence": 0,
"status": "PENDING",
"stopId": "string",
"subProjectId": "mybrand",
"tags": ["string"
],
"waitTime": 0
}

Response samples

400
401
500

Content type

application/json

{"message": "string"
}

Create Jobs (Multibrand)

Create batch of jobs for a particular subproject

Authorizations:

ApiKeyAuth

path Parameters

projectId required	string Project ID
subProjectId required	string SubProject ID

Request Body schema: application/json

Jobs

required

Array of objects (request.UpdateJob)

Responses

Request samples

Payload

Content type

application/json

{"jobs": [{"address": {"country": "Australia",
"countryCode": "AU",
"geoJson": {"coordinates": [144.4913965,
-37.9701481
],
"type": "Point"
},
"locality": "Melbourne",
"postcode": "3000",
"region": "VIC",
"streetAddress": "412 Collins St",
"subStreetAddress": "Level 9"
},
"attributes": { },
"branchId": "1000",
"cancelledAdditionalInfo": "customer not home",
"cancelledReasonCode": "postponed",
"commsChannels": ["email"
],
"commsOptOut": true,
"customer": {"email": "test@example.com",
"firstName": "Margie",
"id": "123",
"lastName": "Moon",
"phone": "+64200000000",
"title": "Mr"
},
"customerInstructions": ["string"
],
"deliveryDate": "string",
"deliveryType": "Standard Delivery",
"driver": {"deviceId": "pat-postie-device",
"employeeId": "employee-123",
"firstName": "Pat",
"lastName": "Postie",
"phone": "+64200000000"
},
"fulfiller": "fastpost",
"id": "string",
"isPriority": true,
"jobItems": [{"attributes": { },
"jobItemId": "qwe12",
"price": 0,
"quantity": 0,
"status": "PENDING",
"stockCode": "string",
"stockName": "string",
"subItems": [{"attributes": { },
"id": "SerialNumber1"
}
]
}
],
"langCode": "en",
"media": [{"attributes": [{"key": "name",
"value": "v1 Pdf File"
}
],
"identifier": "id1",
"mimetype": "application/pdf",
"uri": "media://aaa/bbb.pdf"
}
],
"nominees": [{"email": "test@example.com",
"firstName": "Nina",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
}
],
"plannedEta": "string",
"plannedEtaWindow": {"etaFrom": "2020-10-04T23:45:01+00:00",
"etaTo": "2020-10-04T23:45:01+00:00"
},
"proofOfDelivery": [{"contentType": "image",
"name": "signature",
"value": "http://example.com/signature"
}
],
"scheduleStatus": "CUSTOMER_PENDING",
"secondaryReference": "string",
"sequence": 0,
"status": "PENDING",
"stopId": "string",
"subProjectId": "mybrand",
"tags": ["string"
],
"waitTime": 0
}
]
}

Response samples

200
207
400
401
500

Content type

application/json

{"failed": [{"id": "string",
"reason": "string"
}
],
"jobs": [{"orderNumber": "string",
"subProjectId": "string",
"trackingId": "string"
}
],
"jobsReceived": 0
}

Create Routes (Multibrand)

Create batch of routes for a particular subproject

Authorizations:

ApiKeyAuth

path Parameters

projectId required	string Project ID
subProjectId required	string SubProject ID

Request Body schema: application/json

Routes

required

Array of objects (request.Route)

Responses

Request samples

Payload

Content type

application/json

{"routes": [{"driver": {"deviceId": "pat-postie-device",
"employeeId": "employee-123",
"firstName": "Pat",
"lastName": "Postie",
"phone": "+64200000000"
},
"id": "route1",
"jobs": [{"address": {"country": "Australia",
"countryCode": "AU",
"geoJson": {"coordinates": [144.4913965,
-37.9701481
],
"type": "Point"
},
"locality": "Melbourne",
"postcode": "3000",
"region": "VIC",
"streetAddress": "412 Collins St",
"subStreetAddress": "Level 9"
},
"attributes": { },
"branchId": "1000",
"cancelledAdditionalInfo": "customer not home",
"cancelledReasonCode": "postponed",
"commsChannels": ["email"
],
"commsOptOut": true,
"customer": {"email": "test@example.com",
"firstName": "Margie",
"id": "123",
"lastName": "Moon",
"phone": "+64200000000",
"title": "Mr"
},
"customerInstructions": ["string"
],
"deliveryType": "Standard Delivery",
"fulfiller": "fastpost",
"id": "order123",
"isPriority": true,
"jobItems": [{"attributes": { },
"jobItemId": "qwe12",
"price": 0,
"quantity": 0,
"status": "PENDING",
"stockCode": "string",
"stockName": "string",
"subItems": [{"attributes": { },
"id": "SerialNumber1"
}
]
}
],
"langCode": "en",
"media": [{"attributes": [{"key": "name",
"value": "v1 Pdf File"
}
],
"identifier": "id1",
"mimetype": "application/pdf",
"uri": "media://aaa/bbb.pdf"
}
],
"nominees": [{"email": "test@example.com",
"firstName": "Nina",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
}
],
"plannedEta": "2020-10-04T23:45:01+00:00",
"plannedEtaWindow": {"etaFrom": "2020-10-04T23:45:01+00:00",
"etaTo": "2020-10-04T23:45:01+00:00"
},
"scheduleStatus": "CUSTOMER_PENDING",
"secondaryReference": "order3",
"sequence": 1,
"status": "PENDING",
"stopId": "string",
"subProjectId": "mybrand",
"tags": ["string"
],
"trackingId": "track123",
"waitTime": 240
}
],
"routeDate": "2020-10-04T23:45:01+00:00"
}
]
}

Response samples

200
207
400
401
500

Content type

application/json

{"failed": [{"id": "string",
"reason": "string"
}
],
"jobs": [{"orderNumber": "string",
"subProjectId": "string",
"trackingId": "string"
}
],
"jobsReceived": 0
}

Create Job (Multibrand)

Create new job for a particular subproject

Authorizations:

ApiKeyAuth

path Parameters

projectId required	string Project ID
subProjectId required	string SubProject ID

Request Body schema: application/json

Job

required	object (request.Address)
	object
branchId	string
cancelledAdditionalInfo	string
cancelledReasonCode	string
commsChannels	Array of strings Items Enum: "email" "sms" "voiceCall" "push" "whatsapp" "rcs"
commsOptOut	boolean
	object (github_com_dsg-localz_delivery-import-api_internal_deliveries_request.Customer)
customerInstructions	Array of strings
deliveryDate	string defaults to now if not provided
deliveryType	string
	object (request.NillableDriver) Driver object - if explicitly set to null then the current driver will be unassigned
fulfiller	string
id required	string
isPriority	boolean
	Array of objects (request.JobItem)
langCode	string language code as per ISO-639-1
	Array of objects (github_com_dsg-localz_delivery-import-api_internal_deliveries_request.Media)
	Array of objects (github_com_dsg-localz_delivery-import-api_internal_deliveries_request.Nominee)
plannedEta	string
	object (request.PlannedETAWindow)
scheduleStatus	string Value: "CUSTOMER_PENDING CANCELLED_PENDING CONFIRMED RESCHEDULED SCHEDULED UNSCHEDULED"
secondaryReference	string
sequence	integer
status required	string Enum: "PENDING" "PENDING_PICKED" "PENDING_PACKED" "READY" "DISPATCH" "ARRIVING" "CANCELLED" "DELIVERED" "UNDELIVERED"
stopId	string
subProjectId	string if set, will override any subProjectId in the URL
tags	Array of strings
trackingId	string
waitTime	integer

Responses

Request samples

Payload

Content type

application/json

{"address": {"country": "Australia",
"countryCode": "AU",
"geoJson": {"coordinates": [144.4913965,
-37.9701481
],
"type": "Point"
},
"locality": "Melbourne",
"postcode": "3000",
"region": "VIC",
"streetAddress": "412 Collins St",
"subStreetAddress": "Level 9"
},
"attributes": { },
"branchId": "1000",
"cancelledAdditionalInfo": "customer not home",
"cancelledReasonCode": "postponed",
"commsChannels": ["email"
],
"commsOptOut": true,
"customer": {"email": "test@example.com",
"firstName": "Margie",
"id": "123",
"lastName": "Moon",
"phone": "+64200000000",
"title": "Mr"
},
"customerInstructions": ["string"
],
"deliveryDate": "2020-10-04T23:45:01+00:00",
"deliveryType": "Standard Delivery",
"driver": {"deviceId": "pat-postie-device",
"employeeId": "employee-123",
"firstName": "Pat",
"lastName": "Postie",
"phone": "+64200000000"
},
"fulfiller": "fastpost",
"id": "order123",
"isPriority": true,
"jobItems": [{"attributes": { },
"jobItemId": "qwe12",
"price": 0,
"quantity": 0,
"status": "PENDING",
"stockCode": "string",
"stockName": "string",
"subItems": [{"attributes": { },
"id": "SerialNumber1"
}
]
}
],
"langCode": "en",
"media": [{"attributes": [{"key": "name",
"value": "v1 Pdf File"
}
],
"identifier": "id1",
"mimetype": "application/pdf",
"uri": "media://aaa/bbb.pdf"
}
],
"nominees": [{"email": "test@example.com",
"firstName": "Nina",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
}
],
"plannedEta": "2020-10-04T23:45:01+00:00",
"plannedEtaWindow": {"etaFrom": "2020-10-04T23:45:01+00:00",
"etaTo": "2020-10-04T23:45:01+00:00"
},
"scheduleStatus": "CUSTOMER_PENDING",
"secondaryReference": "order3",
"sequence": 1,
"status": "PENDING",
"stopId": "string",
"subProjectId": "mybrand",
"tags": ["string"
],
"trackingId": "track123",
"waitTime": 240
}

Response samples

400
401
500

Content type

application/json

{"message": "string"
}

Update Job (Multibrand)

Update a job for a particular subproject

Authorizations:

ApiKeyAuth

path Parameters

projectId required	string Project ID
subProjectId required	string SubProject ID

Request Body schema: application/json

Job

	object (request.Address)
	object
branchId	string
cancelledAdditionalInfo	string
cancelledReasonCode	string
commsChannels	Array of strings Items Enum: "email" "sms" "voiceCall" "push" "whatsapp" "rcs"
commsOptOut	boolean
	object (github_com_dsg-localz_delivery-import-api_internal_deliveries_request.Customer)
customerInstructions	Array of strings
deliveryDate	string
deliveryType	string
	object (request.NillableDriver) Driver object - if explicitly set to null then the current driver will be unassigned
fulfiller	string
id	string
isPriority	boolean
	Array of objects (request.JobItem)
langCode	string language code as per ISO-639-1
	Array of objects (github_com_dsg-localz_delivery-import-api_internal_deliveries_request.Media)
	Array of objects (github_com_dsg-localz_delivery-import-api_internal_deliveries_request.Nominee)
plannedEta	string
	object (request.PlannedETAWindow)
	Array of objects (request.ProofOfDelivery) only allowed when Status is DELIVERED or UNDELIVERED
scheduleStatus	string Value: "CUSTOMER_PENDING CANCELLED_PENDING CONFIRMED RESCHEDULED SCHEDULED UNSCHEDULED"
secondaryReference	string
sequence	integer
status required	string Enum: "PENDING" "PENDING_PICKED" "PENDING_PACKED" "DISPATCH" "ARRIVING" "CANCELLED" "DELIVERED" "UNDELIVERED"
stopId	string
subProjectId	string if set, will override any subProjectId in the URL
tags	Array of strings
waitTime	integer

Responses

Request samples

Payload

Content type

application/json

{"address": {"country": "Australia",
"countryCode": "AU",
"geoJson": {"coordinates": [144.4913965,
-37.9701481
],
"type": "Point"
},
"locality": "Melbourne",
"postcode": "3000",
"region": "VIC",
"streetAddress": "412 Collins St",
"subStreetAddress": "Level 9"
},
"attributes": { },
"branchId": "1000",
"cancelledAdditionalInfo": "customer not home",
"cancelledReasonCode": "postponed",
"commsChannels": ["email"
],
"commsOptOut": true,
"customer": {"email": "test@example.com",
"firstName": "Margie",
"id": "123",
"lastName": "Moon",
"phone": "+64200000000",
"title": "Mr"
},
"customerInstructions": ["string"
],
"deliveryDate": "string",
"deliveryType": "Standard Delivery",
"driver": {"deviceId": "pat-postie-device",
"employeeId": "employee-123",
"firstName": "Pat",
"lastName": "Postie",
"phone": "+64200000000"
},
"fulfiller": "fastpost",
"id": "string",
"isPriority": true,
"jobItems": [{"attributes": { },
"jobItemId": "qwe12",
"price": 0,
"quantity": 0,
"status": "PENDING",
"stockCode": "string",
"stockName": "string",
"subItems": [{"attributes": { },
"id": "SerialNumber1"
}
]
}
],
"langCode": "en",
"media": [{"attributes": [{"key": "name",
"value": "v1 Pdf File"
}
],
"identifier": "id1",
"mimetype": "application/pdf",
"uri": "media://aaa/bbb.pdf"
}
],
"nominees": [{"email": "test@example.com",
"firstName": "Nina",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
}
],
"plannedEta": "string",
"plannedEtaWindow": {"etaFrom": "2020-10-04T23:45:01+00:00",
"etaTo": "2020-10-04T23:45:01+00:00"
},
"proofOfDelivery": [{"contentType": "image",
"name": "signature",
"value": "http://example.com/signature"
}
],
"scheduleStatus": "CUSTOMER_PENDING",
"secondaryReference": "string",
"sequence": 0,
"status": "PENDING",
"stopId": "string",
"subProjectId": "mybrand",
"tags": ["string"
],
"waitTime": 0
}

Response samples

400
401
500

Content type

application/json

{"message": "string"
}

Collection - async

Import Orders

Import new orders

Authorizations:

ApiKeyAuth

path Parameters

projectId

required

string

Project ID

Request Body schema: application/json

Orders

required

Array of objects (request.Order)

Responses

Request samples

Payload

Content type

application/json

{"orders": [{"attributes": { },
"availFrom": "2020-10-04T23:45:01+00:00",
"availTo": "2020-10-04T23:45:01+00:00",
"cancelledAdditionalInfo": "customer picking up next week instead",
"cancelledReasonCode": "postponed",
"collectionPoint": "Drive Through",
"commsChannels": ["email"
],
"commsOptOut": true,
"customer": {"email": "test@example.com",
"firstName": "Nina",
"id": "123",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
},
"customerInstructions": ["string"
],
"fulfiller": "fastpost",
"id": "order123",
"isPriority": true,
"langCode": "en",
"media": [{"attributes": [{"key": "name",
"value": "v1 Pdf File"
}
],
"identifier": "id1",
"mimetype": "application/pdf",
"uri": "media://aaa/bbb.pdf"
}
],
"nominees": [{"email": "test@example.com",
"firstName": "Nina",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
}
],
"orderItems": [{"attributes": { },
"orderItemId": "qwe12",
"price": 0,
"quantity": 0,
"status": "PENDING",
"stockCode": "string",
"stockName": "string",
"subItems": [{"attributes": { },
"id": "SerialNumber1"
}
]
}
],
"returnCustomer": true,
"scheduledDate": "2020-10-04T23:45:01+00:00",
"secondaryReference": "ex123",
"status": "PENDING",
"storeId": "1000",
"tags": ["string"
],
"trackId": "track123",
"user": {"firstName": "Nina",
"id": "string",
"lastName": "Simone",
"phone": "+64200000000"
}
}
]
}

Response samples

200
400
401
500

Content type

application/json

{"failed": [{"id": "string",
"reason": "string"
}
],
"orders": [{"orderNumber": "string",
"subProjectId": "string",
"trackingId": "string"
}
],
"ordersReceived": 0
}

Update Order

Update a order

Authorizations:

ApiKeyAuth

path Parameters

projectId required	string Project ID
orderId required	string Order ID

Request Body schema: application/json

Orders

	object
availFrom	string
availTo	string
cancelledAdditionalInfo	string
cancelledReasonCode	string
collectionPoint	string
commsChannels	Array of strings Items Enum: "email" "sms" "voiceCall" "push" "whatsapp" "rcs"
commsOptOut	boolean
	object customer is a required field with commsOptOut
customerInstructions	Array of strings
fulfiller	string
isPriority	boolean
langCode	string language code as per ISO-639-1
	Array of objects (github_com_dsg-localz_delivery-import-api_internal_collections_request.Media)
	Array of objects (github_com_dsg-localz_delivery-import-api_internal_collections_request.Nominee)
	Array of objects (request.OrderItem)
returnCustomer	boolean
scheduledDate	string
secondaryReference	string
status required	string Enum: "PENDING" "PENDING_PICKED" "PENDING_PACKED" "READY" "CANCELLED" "COMPLETE" "FAILEDCOMPLETE" "DISPATCH" "ARRIVING"
storeId	string
tags	Array of strings
trackId	string
	object (request.User)
	object

Responses

Request samples

Payload

Content type

application/json

{"attributes": { },
"availFrom": "2020-10-04T23:45:01+00:00",
"availTo": "2020-10-04T23:45:01+00:00",
"cancelledAdditionalInfo": "customer picking up next week instead",
"cancelledReasonCode": "postponed",
"collectionPoint": "Drive Through",
"commsChannels": ["email"
],
"commsOptOut": true,
"customer": {"email": "test@example.com",
"firstName": "Nina",
"id": "123",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
},
"customerInstructions": ["string"
],
"fulfiller": "fastpost",
"isPriority": true,
"langCode": "en",
"media": [{"attributes": [{"key": "name",
"value": "v1 Pdf File"
}
],
"identifier": "id1",
"mimetype": "application/pdf",
"uri": "media://aaa/bbb.pdf"
}
],
"nominees": [{"email": "test@example.com",
"firstName": "Nina",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
}
],
"orderItems": [{"attributes": { },
"orderItemId": "qwe12",
"price": 0,
"quantity": 0,
"status": "PENDING",
"stockCode": "string",
"stockName": "string",
"subItems": [{"attributes": { },
"id": "SerialNumber1"
}
]
}
],
"returnCustomer": true,
"scheduledDate": "2020-10-04T23:45:01+00:00",
"secondaryReference": "ex123",
"status": "PENDING",
"storeId": "1000",
"tags": ["string"
],
"trackId": "track123",
"user": {"firstName": "Nina",
"id": "string",
"lastName": "Simone",
"phone": "+64200000000"
},
"address": {"country": "Australia",
"countryCode": "AU",
"geoJson": {"coordinates": [144.4913965,
-37.9701481
],
"type": "Point"
},
"locality": "Melbourne",
"postcode": "3000",
"region": "VIC",
"streetAddress": "412 Collins St",
"subStreetAddress": "Level 9"
}
}

Response samples

200
400
401
500

Content type

application/json

{"failed": [{"id": "string",
"reason": "string"
}
],
"orders": [{"orderNumber": "string",
"subProjectId": "string",
"trackingId": "string"
}
],
"ordersReceived": 0
}

Import Orders (Multibrand)

Import new orders for a particular subproject

Authorizations:

ApiKeyAuth

path Parameters

projectId required	string Project ID
subProjectId required	string SubProject ID

Request Body schema: application/json

Orders

required

Array of objects (request.Order)

Responses

Request samples

Payload

Content type

application/json

{"orders": [{"attributes": { },
"availFrom": "2020-10-04T23:45:01+00:00",
"availTo": "2020-10-04T23:45:01+00:00",
"cancelledAdditionalInfo": "customer picking up next week instead",
"cancelledReasonCode": "postponed",
"collectionPoint": "Drive Through",
"commsChannels": ["email"
],
"commsOptOut": true,
"customer": {"email": "test@example.com",
"firstName": "Nina",
"id": "123",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
},
"customerInstructions": ["string"
],
"fulfiller": "fastpost",
"id": "order123",
"isPriority": true,
"langCode": "en",
"media": [{"attributes": [{"key": "name",
"value": "v1 Pdf File"
}
],
"identifier": "id1",
"mimetype": "application/pdf",
"uri": "media://aaa/bbb.pdf"
}
],
"nominees": [{"email": "test@example.com",
"firstName": "Nina",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
}
],
"orderItems": [{"attributes": { },
"orderItemId": "qwe12",
"price": 0,
"quantity": 0,
"status": "PENDING",
"stockCode": "string",
"stockName": "string",
"subItems": [{"attributes": { },
"id": "SerialNumber1"
}
]
}
],
"returnCustomer": true,
"scheduledDate": "2020-10-04T23:45:01+00:00",
"secondaryReference": "ex123",
"status": "PENDING",
"storeId": "1000",
"tags": ["string"
],
"trackId": "track123",
"user": {"firstName": "Nina",
"id": "string",
"lastName": "Simone",
"phone": "+64200000000"
}
}
]
}

Response samples

200
400
401
500

Content type

application/json

{"failed": [{"id": "string",
"reason": "string"
}
],
"orders": [{"orderNumber": "string",
"subProjectId": "string",
"trackingId": "string"
}
],
"ordersReceived": 0
}

Update Order (Multibrand)

Update a order for a particular subproject

Authorizations:

ApiKeyAuth

path Parameters

projectId required	string Project ID
subProjectId required	string SubProject ID
orderId required	string Order ID

Request Body schema: application/json

Orders

	object
availFrom	string
availTo	string
cancelledAdditionalInfo	string
cancelledReasonCode	string
collectionPoint	string
commsChannels	Array of strings Items Enum: "email" "sms" "voiceCall" "push" "whatsapp" "rcs"
commsOptOut	boolean
	object customer is a required field with commsOptOut
customerInstructions	Array of strings
fulfiller	string
isPriority	boolean
langCode	string language code as per ISO-639-1
	Array of objects (github_com_dsg-localz_delivery-import-api_internal_collections_request.Media)
	Array of objects (github_com_dsg-localz_delivery-import-api_internal_collections_request.Nominee)
	Array of objects (request.OrderItem)
returnCustomer	boolean
scheduledDate	string
secondaryReference	string
status required	string Enum: "PENDING" "PENDING_PICKED" "PENDING_PACKED" "READY" "CANCELLED" "COMPLETE" "FAILEDCOMPLETE" "DISPATCH" "ARRIVING"
storeId	string
tags	Array of strings
trackId	string
	object (request.User)
	object

Responses

Request samples

Payload

Content type

application/json

{"attributes": { },
"availFrom": "2020-10-04T23:45:01+00:00",
"availTo": "2020-10-04T23:45:01+00:00",
"cancelledAdditionalInfo": "customer picking up next week instead",
"cancelledReasonCode": "postponed",
"collectionPoint": "Drive Through",
"commsChannels": ["email"
],
"commsOptOut": true,
"customer": {"email": "test@example.com",
"firstName": "Nina",
"id": "123",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
},
"customerInstructions": ["string"
],
"fulfiller": "fastpost",
"isPriority": true,
"langCode": "en",
"media": [{"attributes": [{"key": "name",
"value": "v1 Pdf File"
}
],
"identifier": "id1",
"mimetype": "application/pdf",
"uri": "media://aaa/bbb.pdf"
}
],
"nominees": [{"email": "test@example.com",
"firstName": "Nina",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
}
],
"orderItems": [{"attributes": { },
"orderItemId": "qwe12",
"price": 0,
"quantity": 0,
"status": "PENDING",
"stockCode": "string",
"stockName": "string",
"subItems": [{"attributes": { },
"id": "SerialNumber1"
}
]
}
],
"returnCustomer": true,
"scheduledDate": "2020-10-04T23:45:01+00:00",
"secondaryReference": "ex123",
"status": "PENDING",
"storeId": "1000",
"tags": ["string"
],
"trackId": "track123",
"user": {"firstName": "Nina",
"id": "string",
"lastName": "Simone",
"phone": "+64200000000"
},
"address": {"country": "Australia",
"countryCode": "AU",
"geoJson": {"coordinates": [144.4913965,
-37.9701481
],
"type": "Point"
},
"locality": "Melbourne",
"postcode": "3000",
"region": "VIC",
"streetAddress": "412 Collins St",
"subStreetAddress": "Level 9"
}
}

Response samples

200
400
401
500

Content type

application/json

{"failed": [{"id": "string",
"reason": "string"
}
],
"orders": [{"orderNumber": "string",
"subProjectId": "string",
"trackingId": "string"
}
],
"ordersReceived": 0
}

Collection - sync

Import Orders

Import new orders

Authorizations:

ApiKeyAuth

path Parameters

projectId

required

string

Project ID

Request Body schema: application/json

Orders

required

Array of objects (request.Order)

Responses

Request samples

Payload

Content type

application/json

{"orders": [{"attributes": { },
"availFrom": "2020-10-04T23:45:01+00:00",
"availTo": "2020-10-04T23:45:01+00:00",
"cancelledAdditionalInfo": "customer picking up next week instead",
"cancelledReasonCode": "postponed",
"collectionPoint": "Drive Through",
"commsChannels": ["email"
],
"commsOptOut": true,
"customer": {"email": "test@example.com",
"firstName": "Nina",
"id": "123",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
},
"customerInstructions": ["string"
],
"fulfiller": "fastpost",
"id": "order123",
"isPriority": true,
"langCode": "en",
"media": [{"attributes": [{"key": "name",
"value": "v1 Pdf File"
}
],
"identifier": "id1",
"mimetype": "application/pdf",
"uri": "media://aaa/bbb.pdf"
}
],
"nominees": [{"email": "test@example.com",
"firstName": "Nina",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
}
],
"orderItems": [{"attributes": { },
"orderItemId": "qwe12",
"price": 0,
"quantity": 0,
"status": "PENDING",
"stockCode": "string",
"stockName": "string",
"subItems": [{"attributes": { },
"id": "SerialNumber1"
}
]
}
],
"returnCustomer": true,
"scheduledDate": "2020-10-04T23:45:01+00:00",
"secondaryReference": "ex123",
"status": "PENDING",
"storeId": "1000",
"tags": ["string"
],
"trackId": "track123",
"user": {"firstName": "Nina",
"id": "string",
"lastName": "Simone",
"phone": "+64200000000"
}
}
]
}

Response samples

200
207
400
401
500

Content type

application/json

{"failed": [{"id": "string",
"reason": "string"
}
],
"orders": [{"orderNumber": "string",
"subProjectId": "string",
"trackingId": "string"
}
],
"ordersReceived": 0
}

Update Order

Update an existing order

Authorizations:

ApiKeyAuth

path Parameters

projectId required	string Project ID
orderId required	string Order ID

Request Body schema: application/json

Orders

	object
availFrom	string
availTo	string
cancelledAdditionalInfo	string
cancelledReasonCode	string
collectionPoint	string
commsChannels	Array of strings Items Enum: "email" "sms" "voiceCall" "push" "whatsapp" "rcs"
commsOptOut	boolean
	object customer is a required field with commsOptOut
customerInstructions	Array of strings
fulfiller	string
isPriority	boolean
langCode	string language code as per ISO-639-1
	Array of objects (github_com_dsg-localz_delivery-import-api_internal_collections_request.Media)
	Array of objects (github_com_dsg-localz_delivery-import-api_internal_collections_request.Nominee)
	Array of objects (request.OrderItem)
returnCustomer	boolean
scheduledDate	string
secondaryReference	string
status required	string Enum: "PENDING" "PENDING_PICKED" "PENDING_PACKED" "READY" "CANCELLED" "COMPLETE" "FAILEDCOMPLETE" "DISPATCH" "ARRIVING"
storeId	string
tags	Array of strings
trackId	string
	object (request.User)
	object

Responses

Request samples

Payload

Content type

application/json

{"attributes": { },
"availFrom": "2020-10-04T23:45:01+00:00",
"availTo": "2020-10-04T23:45:01+00:00",
"cancelledAdditionalInfo": "customer picking up next week instead",
"cancelledReasonCode": "postponed",
"collectionPoint": "Drive Through",
"commsChannels": ["email"
],
"commsOptOut": true,
"customer": {"email": "test@example.com",
"firstName": "Nina",
"id": "123",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
},
"customerInstructions": ["string"
],
"fulfiller": "fastpost",
"isPriority": true,
"langCode": "en",
"media": [{"attributes": [{"key": "name",
"value": "v1 Pdf File"
}
],
"identifier": "id1",
"mimetype": "application/pdf",
"uri": "media://aaa/bbb.pdf"
}
],
"nominees": [{"email": "test@example.com",
"firstName": "Nina",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
}
],
"orderItems": [{"attributes": { },
"orderItemId": "qwe12",
"price": 0,
"quantity": 0,
"status": "PENDING",
"stockCode": "string",
"stockName": "string",
"subItems": [{"attributes": { },
"id": "SerialNumber1"
}
]
}
],
"returnCustomer": true,
"scheduledDate": "2020-10-04T23:45:01+00:00",
"secondaryReference": "ex123",
"status": "PENDING",
"storeId": "1000",
"tags": ["string"
],
"trackId": "track123",
"user": {"firstName": "Nina",
"id": "string",
"lastName": "Simone",
"phone": "+64200000000"
},
"address": {"country": "Australia",
"countryCode": "AU",
"geoJson": {"coordinates": [144.4913965,
-37.9701481
],
"type": "Point"
},
"locality": "Melbourne",
"postcode": "3000",
"region": "VIC",
"streetAddress": "412 Collins St",
"subStreetAddress": "Level 9"
}
}

Response samples

400
401
500

Content type

application/json

{"message": "string"
}

Import Orders (Multibrand)

Import new orders for a particular subproject

Authorizations:

ApiKeyAuth

path Parameters

projectId required	string Project ID
subProjectId required	string SubProject ID

Request Body schema: application/json

Orders

required

Array of objects (request.Order)

Responses

Request samples

Payload

Content type

application/json

{"orders": [{"attributes": { },
"availFrom": "2020-10-04T23:45:01+00:00",
"availTo": "2020-10-04T23:45:01+00:00",
"cancelledAdditionalInfo": "customer picking up next week instead",
"cancelledReasonCode": "postponed",
"collectionPoint": "Drive Through",
"commsChannels": ["email"
],
"commsOptOut": true,
"customer": {"email": "test@example.com",
"firstName": "Nina",
"id": "123",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
},
"customerInstructions": ["string"
],
"fulfiller": "fastpost",
"id": "order123",
"isPriority": true,
"langCode": "en",
"media": [{"attributes": [{"key": "name",
"value": "v1 Pdf File"
}
],
"identifier": "id1",
"mimetype": "application/pdf",
"uri": "media://aaa/bbb.pdf"
}
],
"nominees": [{"email": "test@example.com",
"firstName": "Nina",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
}
],
"orderItems": [{"attributes": { },
"orderItemId": "qwe12",
"price": 0,
"quantity": 0,
"status": "PENDING",
"stockCode": "string",
"stockName": "string",
"subItems": [{"attributes": { },
"id": "SerialNumber1"
}
]
}
],
"returnCustomer": true,
"scheduledDate": "2020-10-04T23:45:01+00:00",
"secondaryReference": "ex123",
"status": "PENDING",
"storeId": "1000",
"tags": ["string"
],
"trackId": "track123",
"user": {"firstName": "Nina",
"id": "string",
"lastName": "Simone",
"phone": "+64200000000"
}
}
]
}

Response samples

200
207
400
401
500

Content type

application/json

{"failed": [{"id": "string",
"reason": "string"
}
],
"orders": [{"orderNumber": "string",
"subProjectId": "string",
"trackingId": "string"
}
],
"ordersReceived": 0
}

Update Order (Multibrand)

Update an existing order for a particular subproject

Authorizations:

ApiKeyAuth

path Parameters

projectId required	string Project ID
subProjectId required	string SubProject ID
orderId required	string Order ID

Request Body schema: application/json

Orders

	object
availFrom	string
availTo	string
cancelledAdditionalInfo	string
cancelledReasonCode	string
collectionPoint	string
commsChannels	Array of strings Items Enum: "email" "sms" "voiceCall" "push" "whatsapp" "rcs"
commsOptOut	boolean
	object customer is a required field with commsOptOut
customerInstructions	Array of strings
fulfiller	string
isPriority	boolean
langCode	string language code as per ISO-639-1
	Array of objects (github_com_dsg-localz_delivery-import-api_internal_collections_request.Media)
	Array of objects (github_com_dsg-localz_delivery-import-api_internal_collections_request.Nominee)
	Array of objects (request.OrderItem)
returnCustomer	boolean
scheduledDate	string
secondaryReference	string
status required	string Enum: "PENDING" "PENDING_PICKED" "PENDING_PACKED" "READY" "CANCELLED" "COMPLETE" "FAILEDCOMPLETE" "DISPATCH" "ARRIVING"
storeId	string
tags	Array of strings
trackId	string
	object (request.User)
	object

Responses

Request samples

Payload

Content type

application/json

{"attributes": { },
"availFrom": "2020-10-04T23:45:01+00:00",
"availTo": "2020-10-04T23:45:01+00:00",
"cancelledAdditionalInfo": "customer picking up next week instead",
"cancelledReasonCode": "postponed",
"collectionPoint": "Drive Through",
"commsChannels": ["email"
],
"commsOptOut": true,
"customer": {"email": "test@example.com",
"firstName": "Nina",
"id": "123",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
},
"customerInstructions": ["string"
],
"fulfiller": "fastpost",
"isPriority": true,
"langCode": "en",
"media": [{"attributes": [{"key": "name",
"value": "v1 Pdf File"
}
],
"identifier": "id1",
"mimetype": "application/pdf",
"uri": "media://aaa/bbb.pdf"
}
],
"nominees": [{"email": "test@example.com",
"firstName": "Nina",
"lastName": "Simone",
"phone": "+64200000000",
"title": "Mr"
}
],
"orderItems": [{"attributes": { },
"orderItemId": "qwe12",
"price": 0,
"quantity": 0,
"status": "PENDING",
"stockCode": "string",
"stockName": "string",
"subItems": [{"attributes": { },
"id": "SerialNumber1"
}
]
}
],
"returnCustomer": true,
"scheduledDate": "2020-10-04T23:45:01+00:00",
"secondaryReference": "ex123",
"status": "PENDING",
"storeId": "1000",
"tags": ["string"
],
"trackId": "track123",
"user": {"firstName": "Nina",
"id": "string",
"lastName": "Simone",
"phone": "+64200000000"
},
"address": {"country": "Australia",
"countryCode": "AU",
"geoJson": {"coordinates": [144.4913965,
-37.9701481
],
"type": "Point"
},
"locality": "Melbourne",
"postcode": "3000",
"region": "VIC",
"streetAddress": "412 Collins St",
"subStreetAddress": "Level 9"
}
}

Response samples

400
401
500

Content type

application/json

{"message": "string"
}