Module: order

Order

Methods


<static> cancel(header, body)

POST Cancel order. Note that the returned order does not imply successful cancellation. You need to check the values of order.details.result.cancellation.status and no.

Parameters:
Name Type Description
header YHeader

HTTP request header

body object

HTTP request body

Properties
Name Type Description
_id string

Order identifier

Since:
  • 1.0.0
Returns:
Type
cancelResponse

<static> search(header, body)

POST Search for orders

Parameters:
Name Type Description
header YHeader

HTTP request header

body object

HTTP request body

Properties
Name Type Argument Default Description
filter OrderFilter

Filter criteria

sort string <optional>
byBookedAt

Sorting method

  • byBookedAt Sort by booking date
  • byBookedAtDescending Sort by booking date (descending)
  • byCheckInDate Sort by check-in date
  • byCheckInDateDescending Sort by check-in date (descending)
paging Paging <optional>

Pagination info

Since:
  • 1.0.0
Returns:
Type
searchResponse

Type Definitions


cancelResponse

Type:
  • object
Properties:
Name Type Argument Description
err Error <optional>

Error message

order Order

Order

Since:
  • 1.0.0

searchResponse

Type:
  • object
Properties:
Name Type Argument Description
err Error <optional>

Error message

paging Paging

Pagination info

orders Array.<Order>

List of orders

Since:
  • 1.0.0