Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Update contracts to match version 2.3.4

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

Code Block
languagejs
titleContract
{
    "definitions": {
        "Address": {
      "type": "object",
      "properties": {
                "Address1": {
                    "type": "string"
                },
                "Address2": {
                    "type": "string"
        },
        "ZipCode": {},
          "type": "string"
        },
"City": {
         "City": {
          "type": "string"
                },
                "CountryCode": {
                    "type": "string"
          }
      },
     },
    "ContactInfo": {
      "typeZipCode": "object",
{
         "properties": {
           "Nametype": {"string"
          "type": "string"
     }
   },
        "Email": {
 },
            "type": "stringobject"
        },
        "PhoneContactInfo": {
            "typeproperties": "string"{
        }
        }
"Email": {
         },
    "PickingOrder": {
      "type": "objectstring",
      "properties": {
        "StoreNumber": { },
          "type": "string"
        },
"Name": {
         "OrderNumber": {
          "type": "string"
                },
         "ExternalOrderNumber       "Number": {
                    "type": "string"
        },
        "CurrencyCode": {},
          "type": "string"
        },
"Phone": {
         "OrderVariant": {
          "type": "string",
           "enum": [     }
            "Unknown"},
            "WebReservedStorePickup","type": "object"
            "WebPrepaidWarehouseDelivery"},
            "WebPrepaidDispatchDeliveryDeliveryDetails",: {
            "StorePrepaidWarehouseDeliveryproperties",: {
            "StorePrepaidDispatchDelivery"
     "ContactInfo": {
    ]
        },
        "Delivery$ref": {"#/definitions/ContactInfo"
          "$ref": "#/definitions/DeliveryDetails"
        },
        "OrderLines": {
          "typeDeliveryAddress": "array",
   {
       "items": {
            "$ref": "#/definitions/PickingOrderLineAddress"
          }
        },
        }
    },
    "PickingOrderLineDeliveryPointCode": {
        "            "type": "objectstring",
      "properties": {
        "LineNumber": { },
          "type": "integer"
     "DeliveryPointName ": {
 },
        "SequenceNumber": {
          "type": "integerstring"
        },
        "Gtin": { },
          "type": "string"
     "Method": {
  },
        "QuantityOrdered": {
          "type": "numberstring"
        },
        "QuantityDelivered": {},
          "type": "number"
        },
"OpeningHours": {
         "QuantityPaid": {
          "type": "numberstring"
         }       },
        "Note        "PreferredDateTime": {
            "type": "string"
        }"format": "date-time",
         "IsDeleted": {
          "type": "booleanstring"
                },
        }
    },
    "OrderVariantType": {
      "type": "string",
      "enum": [
       "type": "Unknownstring",
        "WebReservedStorePickup",
        "WebPrepaidWarehouseDelivery",}
        "WebPrepaidDispatchDelivery",
    },
     "StorePrepaidWarehouseDelivery",
       "type": "StorePrepaidDispatchDeliveryobject"
        ]},
    },
    "DeliveryDetailsPickingOrder": {
       "type": "object",
      "properties": {
                "PreferredDateTimePickingStoreNumber": {
                    "type": "string",
           "format": "date-time"     },
        },
        "ContactInfoExternalPickingStoreNumber": {
           "$ref": "#/definitions/ContactInfo"
        },"type": "string"
        "DeliveryAddress": {
          "$ref": "#/definitions/Address"},
        },
        "DeliveryPointCodeOrderStoreNumber": {
                    "type": "string"
         },
        "Method": {
},
            "type": "string"    "ExternalOrderStoreNumber": {
        },
            "OpeningHourstype": {
"string"
                "type": "string"}, 
        },
        "TypeOrderStoreName": {
                    "type": "string"
          }
      },
        }
  }
}

Example JSON:

Code Block
languagejs
titleExample
{     
 "OrderNumber": {
      "storeNumber": "222",     
        "pickingOrderStatustype": "ToBePicked", 
string"
               "orderNumber": "7695227" },
        "externalOrderNumber": "ino784512",
        "currencyCodeExternalOrderNumber": "NOK",{
        "note": "Giftwrap",
            "orderVarianttype": "PrepaidDispatchDeliverystring",
        "delivery": {
       },
     "type": "HomeDelivery",
            "methodCurrencyCode": "1185",
{
                    "deliverypointidtype": "12345678ABCstring",
              "deliveryPointHours": "string"  },
                "preferredDateTimeOrderVariant": "2023-02-10T09:38:47.492Z",{
            "deliveryAddress": {
          "enum": [
      "address1": "Skogsgrenda45",
                "address2": "Unknown",
                   "zipCode": "2164     "WebReservedStorePickup",
                 "city": "SKOGBYGDA",
       "WebPrepaidWarehouseDelivery",
                        "WebPrepaidDispatchDelivery",
                       "country": "NorwayStorePrepaidWarehouseDelivery",
               
         "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:

Code Block
languagejs
titleExample
{
    "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": [
       "contactInfo": {
                "namelineNumber": "FirstnameLastname"1,
                "emailsequenceNumber": "name@gmail.com"0,
                "phonegtin": "+47986532018003299402977",
           
   "sku": "123123",
        }
       "itemNumber": "6920123",
    },
        "orderLinesitemText": [
"Cutlery set",
        {
    "quantityOrdered": 2.0,
            "lineNumberquantityDelivered": 10.0,
                "sequenceNumberquantityPaid": 0.0,
                "gtinquantityPicked": "8003299402977",   //EAN0.0,
            "note": "gift wrap blue paper"quantityOrdered": 2.0,
                "quantityDeliveredisDeleted": 0.0false,
                "quantityPaidarticlePrice": 0110.0,
        },
        "note": "giftwrapbluepaper",
    {
            "isDeletedlineNumber": false2,
           
   
   "sequenceNumber": 1,
     },
    {
   "gtin": "701587439916",
            "lineNumbersku": 2"132132",
                "sequenceNumberitemNumber": 1"5890123",
                "gtinitemText": "701587439916Trench coat",
                "quantityOrdered": 1.0,
            "quantityDelivered": 0.0,
            "quantityDeliveredquantityPaid": 0.0,
                "quantityPaidquantityPicked": 0.0,
                "note": "",
                "isDeleted": false,
           
   "articlePrice": 60.0
        }
    ],
    "collectStartTime": "2023-02-10T09:38:47.492Z",
    "pickupCode": "1234",
    "pickingOrderExportCount": ]10
}