Articles in this section

See more

Get Order Consumer

Avatar
Greg
  • Updated
Follow

Retrieve an Order Consumer by their POS order id. Will only return fields that are set, an empty object or null.

GET ~/orders/:pos-id/consumer

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
:pos-id String

The POS id of the Order to retrieve a consumer for

Response

Field Type Description
name String

The name of the consumer
phone String

The phone of the consumer
email String

The email of the consumer
address String

An object containing Consumer Address details.
  line1 String

The street number and name.
  city String

City.
  state String

State.
  postalCode String

Postal code.
  country String

2-character Country Code.
notes String

Free-text entry for consumer notes such as "Allergic to nuts".

Examples

Response


{
   "name": "Tony Tamplin",
   "phone":"0121211212",
   "email":"t@mail.com",
   "address":{
     "line1":"St Kilda Rd",
     "line2":"Level 6, 616 St Kilda Rd"
     "city":"Melbourne"
     "state":"VIC"
     "postalCode":"3180"
     "country":"AU"
   }
}

 

Related articles

Comments

0 comments

Please sign in to leave a comment.