Catalogue and addresses for human order entry

GET

/entry-drafts/order-options

const url = 'https://example.com/entry-drafts/order-options';
const options = {
  method: 'GET',
  headers: {cookie: '__Host-bottle.session_token=<__Host-bottle.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/entry-drafts/order-options \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Authorizations

sessionCookie
tenant:read

Parameters

Query Parameters

customerId

string format: uuid

Responses

200

Order choices

application/json

object

products

required

Array<object>

object

required

string format: uuid

name

required

string

gasTypeId

required

string | null format: uuid

shortCode

required

string | null

sku

required

string | null

categoryIds

required

Array<string>

kind

required

Cylinder: gas in a bottle. deposit: money held against a cylinder. hire: rent for one. accessory: regulators, hoses, clips. appliance: BBQs, heaters. fuel: coal, logs. consumable: anything used up that is not fuel. delivery: a delivery charge. other: none of these.

string

Allowed values: cylinder deposit hire accessory appliance fuel consumable delivery other

addresses

required

Array<object>

object

required

string format: uuid

label

required

string

deliveryOptions

required

Array<object>

object

required

string format: uuid

name

required

string

Example

{
  "products": [
    {
      "kind": "cylinder"
    }
  ]
}

401

Draft request refused

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Draft request refused

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

404

Draft request refused

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

409

Draft request refused

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Draft request refused

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

429

Draft request refused

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

503

Draft request refused

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}