Order

idint64

The unique ID of the order.

Example: 8948843

versionint64

The version of this order. The version may increment even when no visible changes occur, due to internal processing.

Example: 4

latestVersionboolean

Indicates whether this is the latest version of the order known to Scoffable.

Example: true

vendorIdstring

The unique ID of the vendor location processing the order.

Example: ebd97b79-02b1-41e8-94b4-7821ca2c77ab

statusstring

The high-level status of the order. Possible values:

• placed: The initial status of the order.
• rejected: The order (which was never accepted) has been cancelled.
• accepted: The order was accepted by the vendor location.
• cancelled: The order (previously accepted) has been cancelled.

Possible values: [placed, rejected, accepted, cancelled]

Example: accepted

typestring

The fulfillment method of the order. Possible values:

• collection: The consumer will pick up the order from the vendor.
• delivery: The order will be delivered to the consumer's address.

Possible values: [collection, delivery]

Example: delivery

placedAtdate-time

The timestamp when the order was placed by the consumer.

acceptedAtdate-time

The timestamp when the order was accepted by the vendor. Only present for accepted orders.

cancelledAtdate-time

The timestamp when the order was cancelled. Only present for rejected or cancelled orders.

dispatchedAtdate-time

The timestamp when the order was dispatched. Only present for delivery orders with tracking.

deliveredAtdate-time

The timestamp when the order was delivered to the consumer. Only present for delivery orders with tracking.

returnedAtdate-time

The timestamp when the order was returned to the vendor. Only present for delivery orders with tracking.

deliveryFee object

The amount of the payment

amountint64

The amount in the currency specified. Note that the amount will be represented as a whole number from the least significant digit (e.g 523 USD = $5.23)

Example: 1099

currencystring

ISO 4217 Currency code e.g 'GBP'

Example: GBP

serviceFee object

The amount of the payment

amountint64

The amount in the currency specified. Note that the amount will be represented as a whole number from the least significant digit (e.g 523 USD = $5.23)

Example: 1099

currencystring

ISO 4217 Currency code e.g 'GBP'

Example: GBP

total object

The amount of the payment

amountint64

The amount in the currency specified. Note that the amount will be represented as a whole number from the least significant digit (e.g 523 USD = $5.23)

Example: 1099

currencystring

ISO 4217 Currency code e.g 'GBP'

Example: GBP

items object[]

The line items in the order. May include products, discounts, or vouchers.

Array [

idstring

The unique identifier for this item.

namestring

The name of the item

ageRestrictedboolean

Is this item subject to an age restriction check?

barcodestring

An optional item barcode

vendorReferencestring

An optional item reference that can be used to identify the item at the vendor

typestring

What this line item is

• product: A physical product that has been ordered
• offer: e.g You've added 2 items and you get the third free ... the offer entry would be a price negation of the third item.
• voucher: The consumer has used a promotional voucher code
• adjustment: An adjustment made after the order was placed (defective products, price matching etc).

Possible values: [product, offer, voucher, adjustment]

optionCategories object[]

If this item can be customised, this contains the categories of options that can be chosen (e.g 'Toppings', 'Sides' etc)

Array [

namestring

The name of the group of options (e.g 'Sides', 'Toppings', 'Drinks' etc).

selectedOptions object[]

The options that were selected (e.g 'Plain Chips', 'Peri-Peri Chips', 'Noodles' etc)

Array [

namestring

The name of the selected option (e.g 'Chips')

optionPrice object

The amount of the payment

amountint64

The amount in the currency specified. Note that the amount will be represented as a whole number from the least significant digit (e.g 523 USD = $5.23)

Example: 1099

currencystring

ISO 4217 Currency code e.g 'GBP'

Example: GBP

]

]

quantityOrderedint32

The quantity of this item that was ordered.

quantityFulfilledint32

The quantity of this item that was supplied to the customer.

price object

The amount of the payment

amountint64

The amount in the currency specified. Note that the amount will be represented as a whole number from the least significant digit (e.g 523 USD = $5.23)

Example: 1099

currencystring

ISO 4217 Currency code e.g 'GBP'

Example: GBP

total object

The amount of the payment

amountint64

The amount in the currency specified. Note that the amount will be represented as a whole number from the least significant digit (e.g 523 USD = $5.23)

Example: 1099

currencystring

ISO 4217 Currency code e.g 'GBP'

Example: GBP

priceAdjustmentDetails object

If the price of this item was adjusted after the order was placed, this contains further information

itemsAdjustedstring[]

If this item is an adjustment, this contains a list of items that this adjustment relates to

relatedPriceAdjustmentstring

If this item is a product which has been price adjusted, this is the associated adjustment id

substitutionDetails object

If this item was substituted by another item / substitutes an item, this contains further information

substitutedBystring[]

List of item ids that this item has been replaced by

substitutedForstring[]

List of item ids that this item replaces

]

customerPayments object[]

The payments made for the order, including who collected them (Scoffable or the vendor).

Array [

typestring

The type of payment collected

Possible values: [online, voucher, cash]

Example: online

collectedBystring

Who is receiving the funds from the consumer

Possible values: [scoffable, vendor]

Example: scoffable

payment object

The amount of the payment

amountint64

The amount in the currency specified. Note that the amount will be represented as a whole number from the least significant digit (e.g 523 USD = $5.23)

Example: 1099

currencystring

ISO 4217 Currency code e.g 'GBP'

Example: GBP

]

deliveryProviderstring

Indicates who provided the delivery service.

Possible values: [vendor, uber]

Example: vendor

Order

{
  "id": 8948843,
  "version": 4,
  "latestVersion": true,
  "vendorId": "ebd97b79-02b1-41e8-94b4-7821ca2c77ab",
  "status": "accepted",
  "type": "delivery",
  "placedAt": "2024-07-29T15:51:28.071Z",
  "acceptedAt": "2024-07-29T15:51:28.071Z",
  "cancelledAt": "2024-07-29T15:51:28.071Z",
  "dispatchedAt": "2024-07-29T15:51:28.071Z",
  "deliveredAt": "2024-07-29T15:51:28.071Z",
  "returnedAt": "2024-07-29T15:51:28.071Z",
  "deliveryFee": {
    "amount": 1099,
    "currency": "GBP"
  },
  "serviceFee": {
    "amount": 1099,
    "currency": "GBP"
  },
  "total": {
    "amount": 1099,
    "currency": "GBP"
  },
  "items": [
    {
      "id": "string",
      "name": "string",
      "ageRestricted": true,
      "barcode": "string",
      "vendorReference": "string",
      "type": "product",
      "optionCategories": [
        {
          "name": "string",
          "selectedOptions": [
            {
              "name": "string",
              "optionPrice": {
                "amount": 1099,
                "currency": "GBP"
              }
            }
          ]
        }
      ],
      "quantityOrdered": 0,
      "quantityFulfilled": 0,
      "price": {
        "amount": 1099,
        "currency": "GBP"
      },
      "total": {
        "amount": 1099,
        "currency": "GBP"
      },
      "priceAdjustmentDetails": {
        "itemsAdjusted": [
          "string"
        ],
        "relatedPriceAdjustment": "string"
      },
      "substitutionDetails": {
        "substitutedBy": [
          "string"
        ],
        "substitutedFor": [
          "string"
        ]
      }
    }
  ],
  "customerPayments": [
    {
      "type": "online",
      "collectedBy": "scoffable",
      "payment": {
        "amount": 1099,
        "currency": "GBP"
      }
    }
  ],
  "deliveryProvider": "vendor"
}