Read documentation for how to subscribe to data from EG.
Picking order export
Sample schema and file below. Listen to our integration endpoint to get this file, listen for BlobType='CustomerOrder.Export.PickingOrder'
Contract schema
Contract
{
"definitions": {
"Address": {
"properties": {
"Address1": {
"type": "string"
},
"Address2": {
"type": "string"
},
"City": {
"type": "string"
},
"CountryCode": {
"type": "string"
},
"ZipCode": {
"type": "string"
}
},
"type": "object"
},
"ContactInfo": {
"properties": {
"Email": {
"type": "string"
},
"Name": {
"type": "string"
},
"Number": {
"type": "string"
},
"Phone": {
"type": "string"
}
},
"type": "object"
},
"DeliveryDetails": {
"properties": {
"ContactInfo": {
"$ref": "#/definitions/ContactInfo"
},
"DeliveryAddress": {
"$ref": "#/definitions/Address"
},
"DeliveryPointCode": {
"type": "string"
},
"DeliveryPointName ": {
"type": "string"
},
"Method": {
"type": "string"
},
"OpeningHours": {
"type": "string"
},
"PreferredDateTime": {
"format": "date-time",
"type": "string"
},
"Type": {
"type": "string"
}
},
"type": "object"
},
"PickingOrder": {
"properties": {
"PickingStoreNumber": {
"type": "string"
},
"ExternalPickingStoreNumber": {
"type": "string"
},
"OrderStoreNumber": {
"type": "string"
},
"ExternalOrderStoreNumber": {
"type": "string"
},
"OrderStoreName": {
"type": "string"
},
"OrderNumber": {
"type": "string"
},
"ExternalOrderNumber": {
"type": "string"
},
"CurrencyCode": {
"type": "string"
},
"OrderVariant": {
"enum": [
"Unknown",
"WebReservedStorePickup",
"WebPrepaidWarehouseDelivery",
"WebPrepaidDispatchDelivery",
"StorePrepaidWarehouseDelivery",
"StorePrepaidDispatchDelivery"
],
"type": "string"
},
"PickingOrderStatus": {
"enum": [
"ToBePicked",
"Picking",
"Delivered",
"Rejected",
"DeliveredToCustomer"
],
"type": "string"
},
"Delivery": {
"$ref": "#/definitions/DeliveryDetails"
},
"OrderLines": {
"items": {
"$ref": "#/definitions/PickingOrderLine"
},
"type": "array"
},
"CollectStartTime": {
"format": "date-time",
"type": "string"
},
"PickupCode": {
"type": "string"
},
"PickingOrderExportCount": {
"type": "integer"
}
},
"type": "object"
},
"PickingOrderLine": {
"properties": {
"LineNumber": {
"type": "integer"
},
"SequenceNumber": {
"type": "integer"
},
"Gtin": {
"type": "string"
},
"SKU": {
"type": "string"
},
"ItemNumber": {
"type": "string"
},
"ItemText": {
"type": "string"
},
"QuantityOrdered": {
"type": "number"
},
"QuantityDelivered": {
"type": "number"
},
"QuantityPaid": {
"type": "number"
},
"QuantityPicked": {
"type": "number"
},
"Note": {
"type": "string"
},
"IsDeleted": {
"type": "boolean"
},
"ArticlePrice": {
"type": "number"
}
},
"type": "object"
}
}
}
Example JSON:
Example
{
"pickingStoreNumber": "222",
"externalPickingStoreNumber": "90222",
"orderStoreNumber": "9000",
"externalOrderStoreNumber": "909000",
"orderStoreName": "ExampleStoreName",
"orderNumber": "7695227",
"externalOrderNumber": "ino784512",
"currencyCode": "NOK",
"orderVariant": "PrepaidDispatchDelivery",
"pickingOrderStatus": "ToBePicked",
"delivery": {
"contactInfo": {
"email": "name@gmail.com",
"name": "FirstnameLastname",
"number": "123123123",
"phone": "+4798653201"
},
"deliveryAddress": {
"address1": "Skogsgrenda45",
"address2": "",
"city": "SKOGBYGDA",
"countryCode": "NO",
"zipCode": "2164"
},
"deliveryPointCode": "12345678ABC",
"deliveryPointName": "Store ABC",
"method": "1185",
"deliveryPointHours": "07:00-18:00",
"preferredDateTime": "2023-02-10T09:38:47.492Z",
"type": "HomeDelivery"
},
"orderLines": [
{
"lineNumber": 1,
"sequenceNumber": 0,
"gtin": "8003299402977",
"sku": "123123",
"itemNumber": "6920123",
"itemText": "Cutlery set",
"quantityOrdered": 2.0,
"quantityDelivered": 0.0,
"quantityPaid": 0.0,
"quantityPicked": 0.0,
"note": "gift wrap blue paper",
"isDeleted": false,
"articlePrice": 110.0
},
{
"lineNumber": 2,
"sequenceNumber": 1,
"gtin": "701587439916",
"sku": "132132",
"itemNumber": "5890123",
"itemText": "Trench coat",
"quantityOrdered": 1.0,
"quantityDelivered": 0.0,
"quantityPaid": 0.0,
"quantityPicked": 0.0,
"note": "",
"isDeleted": false,
"articlePrice": 60.0
}
],
"collectStartTime": "2023-02-10T09:38:47.492Z",
"pickupCode": "1234",
"pickingOrderExportCount": 10
}
10 Comments
Nils Teiffel
Michał Kurek where in the swagger do I find this schema?
Michał Kurek
You can't. That's the whole reason why this document exists.
Anna Fridner
Michał Kurek and Vegard Grande we do have a gap related to this contract. We are missing both Item Number and Item description. When integrating with 3rd party as we don in Cervera we need this information.
John Olav Lervik FYI
John Olav Lervik
Michał Kurekand @Vegard Grande. I understand that Item Number and Item Description have been added. Where do I find updated version of contract?
Michał Kurek
John Olav Lervik Contract updated.
Vegard Grande
Maciej Krzysiak / Michal Rogala
Can you take a quick look and see if this contract is up to date? If its not can you update it before lunch today ?
CC: Leif Sveinhaug
Michal Rogala
Vegard Grande Updated to match CustomerOrder.Contracts 2.3.1
Przemyslaw Wozniakowski
Updated contracts to match CustomerOrder.Contracts 2.3.3
Michal Rogala
Updated to match CustomerOrder.Contracts 2.3.4
Leif Sveinhaug
Vegard Grande Michal Rogala
This contract is now moved to the Public section of Confluence