Publicar un menú

​

La estructura de un menú

menu
├── categories[]          (required)
│   └── items[]
│       └── variations[]  (required: at least one — the price lives here)
│           └── modifierGroups[]   (inline, or a reference to a shared group)
├── modifierGroups[]      (shared definitions, referenced by groupId)
├── taxCategories[] / taxRates[]
├── fees[]
└── discounts[] / promotions[] / coupons[]

• Todo objeto tiene un externalId: su identificador estable para ese objeto. Usted los elige; Maple nunca los cambia. Volver a publicar con el mismo externalId actualiza el mismo objeto. La respuesta también genera ID de Maple (item_…, var_…, ctg_…) como referencia, pero usted direcciona los objetos con su externalId.
• El precio está en la variante. Incluso un artículo simple tiene al menos una variante (llámela “Regular”). Todos los precios son enteros en unidades menores: 450 equivale a $4.50.

​

Un menú mínimo

curl -X POST $MAPLE_BASE/locations/{locationId}/menu \
  -H "Authorization: Bearer $MAPLE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "currency": "USD",
    "categories": [
      {
        "externalId": "cat-drinks",
        "name": "Drinks",
        "items": [
          {
            "externalId": "itm-latte",
            "name": "Latte",
            "variations": [
              { "externalId": "var-latte-reg", "name": "Regular", "price": { "amount": { "amountMinor": 450, "currency": "USD" } } }
            ]
          }
        ]
      }
    ]
  }'

​

Agregue modificadores compartidos

{
  "currency": "USD",
  "modifierGroups": [
    {
      "externalId": "grp-milk",
      "name": "Milk",
      "minSelections": 0,
      "maxSelections": 1,
      "options": [
        { "externalId": "mod-whole", "name": "Whole milk" },
        { "externalId": "mod-oat", "name": "Oat milk", "price": { "amount": { "amountMinor": 75, "currency": "USD" } } }
      ]
    }
  ],
  "categories": [
    {
      "externalId": "cat-drinks",
      "name": "Drinks",
      "items": [
        {
          "externalId": "itm-latte",
          "name": "Latte",
          "variations": [{ "externalId": "var-latte-reg", "name": "Regular", "price": { "amount": { "amountMinor": 450, "currency": "USD" } } }],
          "modifierGroups": [{ "groupId": "grp-milk" }]
        }
      ]
    }
  ]
}

​

Semántica de la publicación

• El documento es el menú completo. Lo que usted envíe se convierte en el menú. Un objeto que publicó antes pero omite en una publicación posterior se elimina: para conservarlo, inclúyalo siempre.
• stockStatus es la excepción. Es un valor a nivel de campo: si lo omite en un objeto que sí incluye, se conserva el inventario actual de ese objeto (los objetos nuevos quedan por defecto en in_stock). Por eso, marcar un artículo como agotado sigue siendo una publicación completa que incluye todos los objetos; solo cambia un campo.
• La identidad es su externalId. El mismo externalId actualiza el mismo objeto entre publicaciones; uno nuevo crea un objeto nuevo. Use ID que sean estables en su sistema (un SKU o una clave primaria), no nombres para mostrar.
• Se conserva el orden. Las categorías, los artículos, las variantes y las opciones aparecen en el orden en que los envía.
• La validación es todo o nada. Si algo no es válido, recibe un 400 con todos los problemas y el menú queda exactamente como estaba. Corríjalos todos y vuelva a enviar.
• Las publicaciones idénticas no hacen nada. Enviar el mismo documento no cambia nada ni genera movimiento, así que puede publicar con seguridad en cada cambio del menú.
• Cada cambio genera una versión. Un cambio de contenido crea una versión nueva; el local siempre sirve la actual.

​

Establezca la zona horaria para la disponibilidad

{ "currency": "USD", "timezone": "America/New_York", "categories": [ /* … */ ] }

​

Léalo de vuelta

curl $MAPLE_BASE/locations/{locationId}/menu \
  -H "Authorization: Bearer $MAPLE_KEY"

​

Sepa cuándo se aplica una publicación

​

Siguiente