Articles in this section

See more

Update Pre-Process Order request

Avatar
John Twomey
  • Updated
Follow

Since: v3.4

Update a pre-process request based on its request id

PUT ~/unlinked_orders/preprocess/:request-id

Headers

Field Type Description
Authorization String

Bearer authentication token prefixed with Bearer and a space. See Authentication for more information.
Content-Type String

Request content type, must be 'application/json'
vendor String

The POS vendor name retrieved from Doshii dashboard

Parameters 

Field Type Description
:request-id String

The id of the pre-process request
status String

The status of the request.

status description
rejected The request has been rejected by the POS due to validation issues (unknown item ids, etc)
complete The POS has pre-processed the order, providing any relevant changes to the order details, including pricing.
posAdjustedoptional Boolean

A boolean that indicates whether or not the order has been adjusted by the POS. This should be set to true if the order payload differs from the order details supplied by the App. This property is only mandatory if the status of the request is complete
validUntiloptional Date

A DateTime in ISO8601 format for when the adjustments (e.g. pricing, etc) are no longer valid. Timezone will default to UTC ("Z") time when not provided. eg. 2017-04-12T20:54:25Z. If the value is null, it indicates there is no expiry on the changes. This property is only mandatory if the status of the request is complete.
rejectionCodeoptional String

The code for a rejection. More information can be found by a GET on /rejection-codes/:rejectionCode. This property is only mandatory if the status of the request is rejected.
rejectionReasonoptional String

The reason defined by the POS as why the order was rejected. This property is only mandatory if the status of the request is rejected.
orderoptional Object

This is a complex object containing the full order payload that has been adjusted by the POS. It is possible that it may be identical to the original order submitted. This property is only mandatory if the status of the request is rejected.
  idoptional String

The POS id of the Order. This property is optional, unless the status has been set to accepted.
  notesoptional String

Free-text entry for additional order details
  phaseoptional String

Free-text representation of where the Order is in it's lifecycle at the venue. Eg: 'preparing', 'mains served', 'ready for delivery', etc...
  typeoptional String

The type of order should be one of the following

type description
(null) Standard POS order.
delivery Order ahead to be delivered to the Consumer
pickup Order ahead to be picked up by the Consumer
dinein Order is for dine-in at the venue
  requiredAtoptional String

A DateTime for when the Order is required. Will be null if not a future Order.
  availableEtaoptional String

An estimated DateTime for when the Order is available for pickup/delivery. Will be null if immediately available.
  items Object[]

Array of Product objects.
    posIdoptional String

The POS id of the Product. When not provided, is treated as a custom/open/generic item by the POS.
    nameoptional String

The display name of the Product
    quantityoptional String

The quantity ordered
    descriptionoptional String

A short description of the Product
    unitPriceoptional String

The price of the Product in cents
    totalBeforeSurcountsoptional String

The price of the line item before the Surcounts are applied
    totalAfterSurcountsoptional String

The price of the line item after the Surcounts are applied
    tagsoptional String[]

Array of strings to help group Products together
    surcountsoptional Object[]

Array of Surcount objects.
      posIdoptional String

Id of the item in the POS. Providing this will allow the POS to correctly print and report sales.
      nameoptional String

Name of item.
      descriptionoptional String

Description of item.
      typeoptional String

Whether this is an 'absolute' or 'percentage' Surcount
      amountoptional String

The amount to surcharge/discount (positive/negative integer)
      valueoptional String

The value of the surcounts in cents. Accepts integer or string of integers. This value should be calculated if the Surcount is % based.
    optionsoptional Object[]

Array of options that can be added to the Product
      posIdoptional String

The POS id of the option
      nameoptional String

The display name of the option
      variantsoptional Object[]

The available Variants for the option
        posIdoptional String

The POS id of the Variant
        nameoptional String

The display name of the Variant
        priceoptional String

The price of the Variant in cents
  surcounts Object[]

Array of Surcount objects.
    posIdoptional String

Id of the item in the POS
    nameoptional String

Name of item.
    descriptionoptional String

Description of item.
    typeoptional String

Whether this is an 'absolute' or 'percentage' Surcount
    amountoptional String

The amount to surcharge/discount (positive/negative integer)
    valueoptional String

The value of the surcounts in cents. Accepts integer or string of integers. This value should be calculated if the Surcount is % based.

Response

Field Type Description
id String

Unique number identifying the pre-process request
appId String

Unique id for requesting App.
status String

The current status of the request.

status description
rejected The request has been rejected by the POS
complete The POS has pre-processed the order, providing any relevant changes to the order details, including pricing.
posAdjusted Boolean

A boolean that indicates whether or not the submitted order has been adjusted by the POS. If this property is false then the order that was originally submitted is correct as-is. Will only return if the status of the request is complete.
validUntil Date

A DateTime in ISO8601 format for when the adjustments (e.g. pricing, etc) are no longer valid. Timezone will default to UTC ("Z") time when not provided. eg. 2017-04-12T20:54:25Z. If the value is null, it indicates there is no expiry on the changes. Will only return if the status of the request is complete.
rejectionCode String

The code for a rejection. More information can be found by a GET on /rejection-codes/:rejectionCode. Will only return if set and the status of the request is rejected.
rejectionReason String

The reason defined by the POS as why the order was rejected. Will only return if set and the status of the request is rejected.
updatedAt String

Order last update date
createdAt String

Order creation date

Examples

Request

{
  "id": "719929fe-1db6-4f62-b652-fa96930b1cb8",
  "status": "complete",
  "posAdjusted": true,
  "validUntil": null,
  "order":{
    "type":"pickup",
    "surcounts": [],
    "log": { 
      "employeeId": "1",
      "employeeName": "Jimmy C",
      "employeePosRef": "432324tgr",
      "deviceRef": "213-iPad",
      "deviceName": "Dining Room iPad 1",
      "area": "Dining Room"
    },
    "items":[{
      "name":"Toasted Sourdough Bread & Eggs",
      "description":"Just ye old classic",
      "unitPrice":"1100",
      "totalBeforeSurcounts":"1100",
      "totalAfterSurcounts":"1100",
      "posId":"toasted_eggs",
      "quantity":1,
      "type": "single", 
      "surcounts": [],
      "options": []
    }]
  }
}

Response

{
    "id": "719929fe-1db6-4f62-b652-fa96930b1cb8",
    "status": "complete",
    "appId": "1234",
    "posAdjusted": true,
    "validUntil": null,
    "createdAt": "2018-12-21T04:24:33.138Z",
    "updatedAt": "2018-12-21T04:24:35.138Z"
}

 

Comments

0 comments

Please sign in to leave a comment.