Navigation

Server

Download schema

List menus

GET

https://api.wocart.store

/api/menus

X-API-Key (header)

Every menu of the store, oldest first, with how many items each holds.

List menus › Responses

200

The store's menus

success

boolean · required

MenuSummary[] · required

count

integer · required

POST

https://api.wocart.store

/api/menus

X-API-Key (header)

An empty menu; add its items with PUT /{id}/items.

handle

string · pattern: ^[a-z0-9][a-z0-9-]{0… · required

Lowercase letters, digits and hyphens; how a theme names the menu

title

string · minLength: 1 · maxLength: 100 · required

The new menu

success

boolean · required

MenuDetail · required

POST/api/menus

curl https://api.wocart.store/api/menus \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "handle": "main-menu",
  "title": "Main menu"
}'

Example Request Body

{
  "handle": "main-menu",
  "title": "Main menu"
}

json

Example Responses

{
  "success": true,
  "data": {
    "id": "id",
    "handle": "main-menu",
    "title": "title",
    "updatedAt": "updatedAt",
    "items": [
      {
        "id": "id",
        "label": "label",
        "destination": {
          "type": "home"
        },
        "destinationStatus": "ok",
        "destinationLabel": "destinationLabel",
        "children": [
          {
            "id": "id",
            "label": "label",
            "destination": {
              "type": "home"
            },
            "destinationStatus": "ok",
            "destinationLabel": "destinationLabel",
            "children": [
              {
                "id": "id",
                "label": "label",
                "destination": {
                  "type": "home"
                },
                "destinationStatus": "ok",
                "destinationLabel": "destinationLabel",
                "children": [
                  {}
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

json

application/json

GET

https://api.wocart.store

/api/menus/destinations

X-API-Key (header)

Up to 20 products, categories, store pages or landing pages whose name or slug contains q, each with its public path and whether shoppers can see it now.

type

string · enum · required

Enum values:

category

collection

product

page

landing

q

string · maxLength: 100

Part of the name or slug

200

Matching destinations

success

boolean · required

MenuDestinationOption[] · required

GET

https://api.wocart.store

/api/menus/{id}

X-API-Key (header)

A menu with its item tree. Each item says whether shoppers can follow it (destinationStatus).

id

string · required

Menu id

The menu

success

boolean · required

MenuDetail · required

GET/api/menus/{id}

curl https://api.wocart.store/api/menus/:id \
  --header 'X-API-Key: <api-key>'

Example Responses

{
  "success": true,
  "data": {
    "id": "id",
    "handle": "main-menu",
    "title": "title",
    "updatedAt": "updatedAt",
    "items": [
      {
        "id": "id",
        "label": "label",
        "destination": {
          "type": "home"
        },
        "destinationStatus": "ok",
        "destinationLabel": "destinationLabel",
        "children": [
          {
            "id": "id",
            "label": "label",
            "destination": {
              "type": "home"
            },
            "destinationStatus": "ok",
            "destinationLabel": "destinationLabel",
            "children": [
              {
                "id": "id",
                "label": "label",
                "destination": {
                  "type": "home"
                },
                "destinationStatus": "ok",
                "destinationLabel": "destinationLabel",
                "children": [
                  {}
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

json

application/json

PATCH

https://api.wocart.store

/api/menus/{id}

X-API-Key (header)

Changes its title or handle. A theme reads a menu by handle, so a new handle moves the menu out of every theme setting that named the old one.

id

string · required

Menu id

handle

string · pattern: ^[a-z0-9][a-z0-9-]{0…

Lowercase letters, digits and hyphens; how a theme names the menu

title

string · minLength: 1 · maxLength: 100

The menu

success

boolean · required

MenuDetail · required

PATCH/api/menus/{id}

curl https://api.wocart.store/api/menus/:id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "handle": "main-menu",
  "title": "Main menu"
}'

Example Request Body

{
  "handle": "main-menu",
  "title": "Main menu"
}

json

Example Responses

{
  "success": true,
  "data": {
    "id": "id",
    "handle": "main-menu",
    "title": "title",
    "updatedAt": "updatedAt",
    "items": [
      {
        "id": "id",
        "label": "label",
        "destination": {
          "type": "home"
        },
        "destinationStatus": "ok",
        "destinationLabel": "destinationLabel",
        "children": [
          {
            "id": "id",
            "label": "label",
            "destination": {
              "type": "home"
            },
            "destinationStatus": "ok",
            "destinationLabel": "destinationLabel",
            "children": [
              {
                "id": "id",
                "label": "label",
                "destination": {
                  "type": "home"
                },
                "destinationStatus": "ok",
                "destinationLabel": "destinationLabel",
                "children": [
                  {}
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

json

application/json

DELETE

https://api.wocart.store

/api/menus/{id}

X-API-Key (header)

Deletes the menu with its items and their translations. A theme setting naming it then renders no menu.

id

string · required

Menu id

Deleted

success

boolean · required

object · required

Save a menu's items

PUT

https://api.wocart.store

/api/menus/{id}/items

X-API-Key (header)

Replaces the menu's items with this tree, at once. An item sent with its id keeps it and its translations; an item left out is deleted. At most three levels and 100 items.

Save a menu's items › path Parameters

id

string · required

Menu id

Save a menu's items › Request Body

MenuItemInput[] · required

The whole tree, in order; at most three levels and 100 items

Save a menu's items › Responses

The menu as saved

success

boolean · required

MenuDetail · required

PUT/api/menus/{id}/items

curl https://api.wocart.store/api/menus/:id/items \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "items": [
    {
      "id": "id",
      "label": "Robes",
      "destination": {
        "type": "home"
      },
      "children": [
        {
          "id": "id",
          "label": "Robes",
          "destination": {
            "type": "home"
          },
          "children": [
            {
              "id": "id",
              "label": "Robes",
              "destination": {
                "type": "home"
              }
            }
          ]
        }
      ]
    }
  ]
}'

Example Request Body

{
  "items": [
    {
      "id": "id",
      "label": "Robes",
      "destination": {
        "type": "home"
      },
      "children": [
        {
          "id": "id",
          "label": "Robes",
          "destination": {
            "type": "home"
          },
          "children": [
            {
              "id": "id",
              "label": "Robes",
              "destination": {
                "type": "home"
              }
            }
          ]
        }
      ]
    }
  ]
}

json

Example Responses

{
  "success": true,
  "data": {
    "id": "id",
    "handle": "main-menu",
    "title": "title",
    "updatedAt": "updatedAt",
    "items": [
      {
        "id": "id",
        "label": "label",
        "destination": {
          "type": "home"
        },
        "destinationStatus": "ok",
        "destinationLabel": "destinationLabel",
        "children": [
          {
            "id": "id",
            "label": "label",
            "destination": {
              "type": "home"
            },
            "destinationStatus": "ok",
            "destinationLabel": "destinationLabel",
            "children": [
              {
                "id": "id",
                "label": "label",
                "destination": {
                  "type": "home"
                },
                "destinationStatus": "ok",
                "destinationLabel": "destinationLabel",
                "children": [
                  {}
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

json

application/json

GET

https://api.wocart.store

/api/menus/items/{id}/translations

X-API-Key (header)

The translatable fields in the store's primary language and every stored translation, each flagged outdated when its source text changed after it was written.

id

string · required

200

Source and translations

success

boolean · required

object · required

GET/api/menus/items/{id}/translations

curl https://api.wocart.store/api/menus/items/:id/translations \
  --header 'X-API-Key: <api-key>'

Example Responses

{
  "success": true,
  "data": {
    "resource": "resource",
    "id": "id",
    "sourceLocale": "ar",
    "targetLocales": [
      {
        "locale": "ar",
        "published": true
      }
    ],
    "source": {
      "key": "string"
    },
    "options": [
      {
        "name": "name",
        "key": "key",
        "values": [
          {
            "value": "value",
            "key": "key"
          }
        ]
      }
    ],
    "translations": {
      "ar": {
        "key": {
          "value": "value",
          "outdated": true
        }
      },
      "fr": {
        "key": {
          "value": "value",
          "outdated": true
        }
      },
      "en": {
        "key": {
          "value": "value",
          "outdated": true
        }
      }
    }
  }
}

json

application/json

PATCH

https://api.wocart.store

/api/menus/items/{id}/translations

X-API-Key (header)

A JSON Merge Patch (RFC 7396) of one language: a string sets a field, null removes its translation, other fields are untouched. The language must be one the store has added, and not its primary — the resource's own fields hold that.

id

string · required

locale

string · enum · required

Enum values:

object · required

200

Source and translations after the patch

success

boolean · required

object · required

PATCH/api/menus/items/{id}/translations

curl https://api.wocart.store/api/menus/items/:id/translations \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "locale": "ar",
  "values": {
    "label": "label"
  }
}'

Example Request Body

{
  "locale": "ar",
  "values": {
    "label": "label"
  }
}

json

Example Responses

{
  "success": true,
  "data": {
    "resource": "resource",
    "id": "id",
    "sourceLocale": "ar",
    "targetLocales": [
      {
        "locale": "ar",
        "published": true
      }
    ],
    "source": {
      "key": "string"
    },
    "options": [
      {
        "name": "name",
        "key": "key",
        "values": [
          {
            "value": "value",
            "key": "key"
          }
        ]
      }
    ],
    "translations": {
      "ar": {
        "key": {
          "value": "value",
          "outdated": true
        }
      },
      "fr": {
        "key": {
          "value": "value",
          "outdated": true
        }
      },
      "en": {
        "key": {
          "value": "value",
          "outdated": true
        }
      }
    }
  }
}

json

application/json

Store Pages Checkout Form

Navigation

List menus

List menus › Responses

Create a menu

Create a menu › Request Body

Create a menu › Responses

Find what a menu item can point at

Find what a menu item can point at › query Parameters

Find what a menu item can point at › Responses

Get a menu

Get a menu › path Parameters

Get a menu › Responses

Rename a menu

Rename a menu › path Parameters

Rename a menu › Request Body

Rename a menu › Responses

Delete a menu

Delete a menu › path Parameters

Delete a menu › Responses

Save a menu's items

Save a menu's items › path Parameters

Save a menu's items › Request Body

Save a menu's items › Responses

Get a menu item's translations

Get a menu item's translations › path Parameters

Get a menu item's translations › Responses

Translate a menu item into one language

Translate a menu item into one language › path Parameters

Translate a menu item into one language › Request Body

Translate a menu item into one language › Responses