Put a menu in the bin

POST

/storefront/bin/menus/{id}

const url = 'https://example.com/storefront/bin/menus/example';
const options = {
  method: 'POST',
  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 POST \
  --url https://example.com/storefront/bin/menus/example \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Keeps the menu, as it is in the saved draft, in the bin for 90 days. Called as a menu is deleted, before the draft without it is saved: a menu left out of the draft any other way (an undo, discarding changes) is not put in the bin. A menu still in the draft when it is next saved leaves the bin.

Authorizations

sessionCookie
storefront:write
apiKey
storefront:write

Parameters

Path Parameters

required

string

/^[a-z0-9-]{1,40}$/

Responses

200

What is in the bin

application/json

object

required

The bin entry, for restoring or deleting for good.

string format: uuid

kind

required

string

Allowed values: page post menu

itemId

required

string

name

required

Its title or name when it was deleted.

string

deletedAt

required

string format: date-time

deletedBy

required

object

kind

required

Person: someone signed in. key: an API key. assistant: an app connected over MCP. support: Bottle staff in a support session the business allowed.

string

Allowed values: person key assistant support

name

required

The person’s name then, or the key’s or the app’s.

string

goneAt

required

When it is removed for good.

string format: date-time

wasPublished

required

A page or post that was on the shop when it was deleted. It comes back as a draft: publish it again to put it back.

boolean

daysLeft

required

integer

Example

{
  "kind": "page",
  "deletedBy": {
    "kind": "person"
  }
}

401

Not signed in

application/json

object

error

required

string

message

required

string

Example

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

402

The plan does not include a shop

application/json

object

error

required

string

message

required

string

Example

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

403

Not a member, or without the permission this needs

application/json

object

error

required

string

message

required

string

Example

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

404

No such menu in the saved draft

application/json

object

error

required

string

message

required

string

Example

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