Menu
Get location menu
The location's current published menu: categories, items, and variations (prices in integer minor units), shared modifier groups, and tax/fee/discount definitions.
此内容尚不支持你的语言。
https://api.maple.inc/v1/locations/{locationId}/menuAPI keyThe location’s current published menu: categories, items, and variations (prices in integer minor units), shared modifier groups, and tax/fee/discount definitions. Every object echoes the externalId you published it under. Requires menus:read and an active connection to the location.
Authorization
Send your API key as Authorization: Bearer <key>: mpk_test_… against the sandbox (https://api.staging.maple.inc/v1), mpk_live_… against production. See Authentication. The samples read the key from MAPLE_KEY and the base URL from MAPLE_BASE, as set up in the Quickstart.
Parameters
locationIdstring required
Responses
200 OK
-
catalogIdstring required -
storePublicIdstring required -
versionIdstring required -
currencystring required -
localestring -
timezonestring -
currenciesobject[] required -
currencies[].currencystring required -
currencies[].exponentinteger -
currencies[].cashRoundingMinorinteger -
currencies[].roundingModestringOne of
half_up,half_even,half_down,up,down,ceiling,floor. -
taxCategoriesobject[] required -
taxCategories[].idstring -
taxCategories[].externalIdstring -
taxCategories[].namestring required -
taxRatesobject[] required -
taxRates[].idstring -
taxRates[].externalIdstring -
taxRates[].namestring required -
taxRates[].taxCategoryIdstring -
taxRates[].methodstringOne of
percentage,flat,bracket. -
taxRates[].percentagenumber -
taxRates[].flatAmountobject -
taxRates[].flatAmount.amountMinorinteger required -
taxRates[].flatAmount.currencystring required -
taxRates[].bracketsobject[] -
taxRates[].brackets[].fromobject required -
taxRates[].brackets[].from.amountMinorinteger required -
taxRates[].brackets[].from.currencystring required -
taxRates[].brackets[].toobject -
taxRates[].brackets[].to.amountMinorinteger required -
taxRates[].brackets[].to.currencystring required -
taxRates[].brackets[].taxobject required -
taxRates[].brackets[].tax.amountMinorinteger required -
taxRates[].brackets[].tax.currencystring required -
taxRates[].basestringOne of
price,price_plus_prior_taxes,weight,volume,quantity,alcohol_content. -
taxRates[].inclusionstringOne of
exclusive,inclusive,context_resolved. -
taxRates[].compoundOnTaxRateIdsstring[] -
taxRates[].tenderExemptionsstring[] -
taxRates[].conditionobject -
taxRates[].condition.minPriceobject -
taxRates[].condition.minPrice.amountMinorinteger required -
taxRates[].condition.minPrice.currencystring required -
taxRates[].condition.maxPriceobject -
taxRates[].condition.maxPrice.amountMinorinteger required -
taxRates[].condition.maxPrice.currencystring required -
taxRates[].condition.jurisdictionstring -
taxRates[].condition.attributesobject[] -
taxRates[].condition.attributes[].keystring required -
taxRates[].condition.attributes[].valuestring required -
taxRates[].hiddenFromCustomerboolean -
feesobject[] required -
fees[].idstring -
fees[].externalIdstring -
fees[].namestring required -
fees[].feeTypestring requiredOne of
delivery,service_charge,bag,bottle_deposit,crv,small_order,processing_pass_through,deposit,security_hold,no_show_fee,cancellation_fee,auto_gratuity,non_cash_adjustment,other. -
fees[].calculationobject required -
fees[].calculation.basestring requiredOne of
flat,per_unit,percentage_of_line,percentage_of_subtotal,post_discount,post_tax_total. -
fees[].calculation.amountobject -
fees[].calculation.amount.amountMinorinteger required -
fees[].calculation.amount.currencystring required -
fees[].calculation.percentagenumber -
fees[].calculation.eligibleProductSetIdstring -
fees[].calculation.excludedProductSetIdsstring[] -
fees[].taxCategoryIdstring -
fees[].refundableboolean -
fees[].autoApplyobject -
fees[].autoApply.byGuestCountGteinteger -
fees[].autoApply.byFulfillmentModestring[] -
fees[].containersobject[] -
fees[].containers[].containerSizeMlnumber -
fees[].containers[].amountobject required -
fees[].containers[].amount.amountMinorinteger required -
fees[].containers[].amount.currencystring required -
productSetsobject[] required -
productSets[].idstring -
productSets[].externalIdstring -
productSets[].namestring -
productSets[].itemIdsAnystring[] -
productSets[].itemIdsAllstring[] -
productSets[].allProductsboolean -
productSets[].quantityExactinteger -
productSets[].quantityMininteger -
productSets[].quantityMaxinteger -
discountsobject[] required -
discounts[].idstring -
discounts[].externalIdstring -
discounts[].namestring required -
discounts[].benefitTypestring requiredOne of
percentage,amount,set_price,free_item,bxgy,free_fee. -
discounts[].amountobject -
discounts[].amount.amountMinorinteger required -
discounts[].amount.currencystring required -
discounts[].percentagenumber -
discounts[].maximumAmountobject -
discounts[].maximumAmount.amountMinorinteger required -
discounts[].maximumAmount.currencystring required -
discounts[].benefitTargetProductSetIdstring -
discounts[].lineSelectionstringOne of
least_expensive,most_expensive. -
discounts[].bxgyobject -
discounts[].bxgy.buyProductSetIdstring required -
discounts[].bxgy.buyQuantityinteger required -
discounts[].bxgy.getProductSetIdstring required -
discounts[].bxgy.getQuantityinteger required -
discounts[].bxgy.getBenefitstring requiredOne of
free,percentage,set_price,amount. -
discounts[].bxgy.getBenefitAmountobject -
discounts[].bxgy.getBenefitAmount.amountMinorinteger required -
discounts[].bxgy.getBenefitAmount.currencystring required -
discounts[].bxgy.getBenefitPercentagenumber -
discounts[].bxgy.customerChoosesRewardboolean -
discounts[].bxgy.excludeStrategystringOne of
least_expensive,most_expensive. -
discounts[].freeFeeTargetsstring[] -
discounts[].modifiesTaxBasisboolean -
promotionsobject[] required -
promotions[].idstring -
promotions[].externalIdstring -
promotions[].namestring required -
promotions[].discountIdstring required -
promotions[].applicationModestringOne of
automatic,coupon,manual. -
promotions[].eligibilityobject -
promotions[].eligibility.minimumOrderSubtotalobject -
promotions[].eligibility.minimumOrderSubtotal.amountMinorinteger required -
promotions[].eligibility.minimumOrderSubtotal.currencystring required -
promotions[].eligibility.matchProductSetIdstring -
promotions[].eligibility.excludeProductSetIdstring -
promotions[].availabilityobject -
promotions[].availability.windowsobject[] required -
promotions[].availability.windows[].dayOfWeekinteger required -
promotions[].availability.windows[].startTimestring required -
promotions[].availability.windows[].endTimestring required -
promotions[].validFromstring -
promotions[].validUntilstring -
promotions[].stackingobject -
promotions[].stacking.modestring requiredOne of
exclusive,additive,best_of,ordered. -
promotions[].stacking.priorityinteger -
promotions[].redemptionobject -
promotions[].redemption.maxUsesTotalinteger -
promotions[].redemption.maxUsesPerCustomerinteger -
couponsobject[] required -
coupons[].idstring -
coupons[].externalIdstring -
coupons[].codestring required -
coupons[].promotionIdstring required -
coupons[].maxRedemptionsinteger -
coupons[].perCustomerLimitinteger -
coupons[].expiresAtstring -
modifierGroupsobject[] required -
modifierGroups[].idstring -
modifierGroups[].externalIdstring required -
modifierGroups[].namestring required -
modifierGroups[].inputTypestringOne of
options,text. -
modifierGroups[].minSelectionsinteger required -
modifierGroups[].maxSelectionsinteger required -
modifierGroups[].minUniqueSelectionsinteger -
modifierGroups[].maxUniqueSelectionsinteger -
modifierGroups[].freeSelectionCountinteger -
modifierGroups[].chargeKeptDefaultsboolean -
modifierGroups[].allowedQuantitiesinteger[] -
modifierGroups[].optionsobject[] -
modifierGroups[].options[].idstring -
modifierGroups[].options[].externalIdstring required -
modifierGroups[].options[].namestring required -
modifierGroups[].options[].priceobject -
modifierGroups[].options[].price.amountobject -
modifierGroups[].options[].price.amount.amountMinorinteger required -
modifierGroups[].options[].price.amount.currencystring required -
modifierGroups[].options[].price.priceTypestringOne of
fixed,variable,per_unit,bulk. -
modifierGroups[].options[].price.taxInclusiveboolean -
modifierGroups[].options[].price.currencyPricesobject[] -
modifierGroups[].options[].price.currencyPrices[].amountobject required -
modifierGroups[].options[].price.currencyPrices[].amount.amountMinorinteger required -
modifierGroups[].options[].price.currencyPrices[].amount.currencystring required -
modifierGroups[].options[].price.currencyPrices[].taxInclusiveboolean -
modifierGroups[].options[].price.openBoundsobject -
modifierGroups[].options[].price.openBounds.minobject -
modifierGroups[].options[].price.openBounds.min.amountMinorinteger required -
modifierGroups[].options[].price.openBounds.min.currencystring required -
modifierGroups[].options[].price.openBounds.maxobject -
modifierGroups[].options[].price.openBounds.max.amountMinorinteger required -
modifierGroups[].options[].price.openBounds.max.currencystring required -
modifierGroups[].options[].price.openBounds.presetsobject[] -
modifierGroups[].options[].price.openBounds.presets[].amountMinorinteger required -
modifierGroups[].options[].price.openBounds.presets[].currencystring required -
modifierGroups[].options[].price.bulkTiersobject[] -
modifierGroups[].options[].price.bulkTiers[].minQuantityinteger required -
modifierGroups[].options[].price.bulkTiers[].unitPriceobject required -
modifierGroups[].options[].price.bulkTiers[].unitPrice.amountMinorinteger required -
modifierGroups[].options[].price.bulkTiers[].unitPrice.currencystring required -
modifierGroups[].options[].price.measurementUnitobject -
modifierGroups[].options[].price.measurementUnit.unitstring required -
modifierGroups[].options[].price.measurementUnit.precisioninteger -
modifierGroups[].options[].price.compareAtAmountobject -
modifierGroups[].options[].price.compareAtAmount.amountMinorinteger required -
modifierGroups[].options[].price.compareAtAmount.currencystring required -
modifierGroups[].options[].defaultQuantityinteger -
modifierGroups[].options[].minQuantityinteger -
modifierGroups[].options[].maxQuantityinteger -
modifierGroups[].options[].taxCategoryIdstring -
modifierGroups[].options[].taxRateIdsstring[] -
modifierGroups[].options[].dietaryLabelsstring[] -
modifierGroups[].options[].allergensstring[] -
modifierGroups[].options[].stockStatusstringOne of
in_stock,out_of_stock,low_stock. -
modifierGroups[].options[].modifierGroupsobject[] -
modifierGroups[].options[].modifierGroups[].groupIdstring -
modifierGroups[].options[].modifierGroups[].minSelectionsinteger -
modifierGroups[].options[].modifierGroups[].maxSelectionsinteger -
modifierGroups[].options[].modifierGroups[].minUniqueSelectionsinteger -
modifierGroups[].options[].modifierGroups[].maxUniqueSelectionsinteger -
modifierGroups[].options[].modifierGroups[].freeSelectionCountinteger -
modifierGroups[].options[].modifierGroups[].chargeKeptDefaultsboolean -
modifierGroups[].options[].modifierGroups[].allowedQuantitiesinteger[] -
modifierGroups[].options[].modifierGroups[].optionDefaultsobject[] -
modifierGroups[].options[].modifierGroups[].optionDefaults[].optionIdstring -
modifierGroups[].options[].modifierGroups[].optionDefaults[].defaultQuantityinteger -
modifierGroups[].options[].modifierGroups[].externalIdany -
modifierGroups[].options[].modifierGroups[].nameany -
modifierGroups[].options[].modifierGroups[].optionsany -
modifierGroups[].options[].modifierGroups[].idstring -
modifierGroups[].options[].modifierGroups[].inputTypestringOne of
options,text. -
modifierGroups[].options[].modifierGroups[].options[].idstring -
modifierGroups[].options[].modifierGroups[].options[].externalIdstring -
modifierGroups[].options[].modifierGroups[].options[].namestring -
modifierGroups[].options[].modifierGroups[].options[].priceobject -
modifierGroups[].options[].modifierGroups[].options[].price.amountobject -
modifierGroups[].options[].modifierGroups[].options[].price.priceTypestringOne of
fixed,variable,per_unit,bulk. -
modifierGroups[].options[].modifierGroups[].options[].price.taxInclusiveboolean -
modifierGroups[].options[].modifierGroups[].options[].price.currencyPricesobject[] -
modifierGroups[].options[].modifierGroups[].options[].price.openBoundsobject -
modifierGroups[].options[].modifierGroups[].options[].price.bulkTiersobject[] -
modifierGroups[].options[].modifierGroups[].options[].price.measurementUnitobject -
modifierGroups[].options[].modifierGroups[].options[].price.compareAtAmountobject -
modifierGroups[].options[].modifierGroups[].options[].defaultQuantityinteger -
modifierGroups[].options[].modifierGroups[].options[].minQuantityinteger -
modifierGroups[].options[].modifierGroups[].options[].maxQuantityinteger -
modifierGroups[].options[].modifierGroups[].options[].taxCategoryIdstring -
modifierGroups[].options[].modifierGroups[].options[].taxRateIdsstring[] -
modifierGroups[].options[].modifierGroups[].options[].dietaryLabelsstring[] -
modifierGroups[].options[].modifierGroups[].options[].allergensstring[] -
modifierGroups[].options[].modifierGroups[].options[].stockStatusstringOne of
in_stock,out_of_stock,low_stock. -
modifierGroups[].options[].modifierGroups[].options[].modifierGroupsobject[] -
modifierGroups[].options[].modifierGroups[].options[].modifierGroups[].groupIdstring -
modifierGroups[].options[].modifierGroups[].options[].modifierGroups[].minSelectionsinteger -
modifierGroups[].options[].modifierGroups[].options[].modifierGroups[].maxSelectionsinteger -
modifierGroups[].options[].modifierGroups[].options[].modifierGroups[].minUniqueSelectionsinteger -
modifierGroups[].options[].modifierGroups[].options[].modifierGroups[].maxUniqueSelectionsinteger -
modifierGroups[].options[].modifierGroups[].options[].modifierGroups[].freeSelectionCountinteger -
modifierGroups[].options[].modifierGroups[].options[].modifierGroups[].chargeKeptDefaultsboolean -
modifierGroups[].options[].modifierGroups[].options[].modifierGroups[].allowedQuantitiesinteger[] -
modifierGroups[].options[].modifierGroups[].options[].modifierGroups[].optionDefaultsobject[] -
modifierGroups[].options[].modifierGroups[].options[].modifierGroups[].externalIdany -
modifierGroups[].options[].modifierGroups[].options[].modifierGroups[].nameany -
modifierGroups[].options[].modifierGroups[].options[].modifierGroups[].optionsany -
modifierGroups[].options[].modifierGroups[].options[].modifierGroups[].idstring -
modifierGroups[].options[].modifierGroups[].options[].modifierGroups[].inputTypestringOne of
options,text. -
modifierGroups[].options[].modifierGroups[].options[].modifierGroups[].textMaxLengthinteger -
modifierGroups[].options[].modifierGroups[].textMaxLengthinteger -
modifierGroups[].textMaxLengthinteger -
modifierGroups[].groupIdany -
categoriesobject[] required -
categories[].idstring -
categories[].externalIdstring required -
categories[].namestring required -
categories[].availabilityobject -
categories[].availability.windowsobject[] required -
categories[].availability.windows[].dayOfWeekinteger required -
categories[].availability.windows[].startTimestring required -
categories[].availability.windows[].endTimestring required -
categories[].itemsobject[] required -
categories[].items[].idstring -
categories[].items[].externalIdstring required -
categories[].items[].namestring required -
categories[].items[].descriptionstring -
categories[].items[].variationsobject[] required -
categories[].items[].variations[].idstring -
categories[].items[].variations[].externalIdstring required -
categories[].items[].variations[].namestring required -
categories[].items[].variations[].priceobject required -
categories[].items[].variations[].price.amountobject -
categories[].items[].variations[].price.amount.amountMinorinteger required -
categories[].items[].variations[].price.amount.currencystring required -
categories[].items[].variations[].price.priceTypestringOne of
fixed,variable,per_unit,bulk. -
categories[].items[].variations[].price.taxInclusiveboolean -
categories[].items[].variations[].price.currencyPricesobject[] -
categories[].items[].variations[].price.currencyPrices[].amountobject required -
categories[].items[].variations[].price.currencyPrices[].taxInclusiveboolean -
categories[].items[].variations[].price.openBoundsobject -
categories[].items[].variations[].price.openBounds.minobject -
categories[].items[].variations[].price.openBounds.maxobject -
categories[].items[].variations[].price.openBounds.presetsobject[] -
categories[].items[].variations[].price.bulkTiersobject[] -
categories[].items[].variations[].price.bulkTiers[].minQuantityinteger required -
categories[].items[].variations[].price.bulkTiers[].unitPriceobject required -
categories[].items[].variations[].price.measurementUnitobject -
categories[].items[].variations[].price.measurementUnit.unitstring required -
categories[].items[].variations[].price.measurementUnit.precisioninteger -
categories[].items[].variations[].price.compareAtAmountobject -
categories[].items[].variations[].price.compareAtAmount.amountMinorinteger required -
categories[].items[].variations[].price.compareAtAmount.currencystring required -
categories[].items[].variations[].skustring -
categories[].items[].variations[].barcodesstring[] -
categories[].items[].variations[].modifierGroupsobject[] -
categories[].items[].variations[].modifierGroups[].groupIdstring -
categories[].items[].variations[].modifierGroups[].minSelectionsinteger -
categories[].items[].variations[].modifierGroups[].maxSelectionsinteger -
categories[].items[].variations[].modifierGroups[].minUniqueSelectionsinteger -
categories[].items[].variations[].modifierGroups[].maxUniqueSelectionsinteger -
categories[].items[].variations[].modifierGroups[].freeSelectionCountinteger -
categories[].items[].variations[].modifierGroups[].chargeKeptDefaultsboolean -
categories[].items[].variations[].modifierGroups[].allowedQuantitiesinteger[] -
categories[].items[].variations[].modifierGroups[].optionDefaultsobject[] -
categories[].items[].variations[].modifierGroups[].optionDefaults[].optionIdstring -
categories[].items[].variations[].modifierGroups[].optionDefaults[].defaultQuantityinteger -
categories[].items[].variations[].modifierGroups[].externalIdany -
categories[].items[].variations[].modifierGroups[].nameany -
categories[].items[].variations[].modifierGroups[].optionsany -
categories[].items[].variations[].modifierGroups[].idstring -
categories[].items[].variations[].modifierGroups[].inputTypestringOne of
options,text. -
categories[].items[].variations[].modifierGroups[].options[].idstring -
categories[].items[].variations[].modifierGroups[].options[].externalIdstring -
categories[].items[].variations[].modifierGroups[].options[].namestring -
categories[].items[].variations[].modifierGroups[].options[].priceobject -
categories[].items[].variations[].modifierGroups[].options[].defaultQuantityinteger -
categories[].items[].variations[].modifierGroups[].options[].minQuantityinteger -
categories[].items[].variations[].modifierGroups[].options[].maxQuantityinteger -
categories[].items[].variations[].modifierGroups[].options[].taxCategoryIdstring -
categories[].items[].variations[].modifierGroups[].options[].taxRateIdsstring[] -
categories[].items[].variations[].modifierGroups[].options[].dietaryLabelsstring[] -
categories[].items[].variations[].modifierGroups[].options[].allergensstring[] -
categories[].items[].variations[].modifierGroups[].options[].stockStatusstringOne of
in_stock,out_of_stock,low_stock. -
categories[].items[].variations[].modifierGroups[].options[].modifierGroupsobject[] -
categories[].items[].variations[].modifierGroups[].textMaxLengthinteger -
categories[].items[].variations[].dietaryLabelsstring[] -
categories[].items[].variations[].allergensstring[] -
categories[].items[].variations[].calorieCountinteger -
categories[].items[].variations[].stockStatusstringOne of
in_stock,out_of_stock,low_stock. -
categories[].items[].modifierGroupsobject[] -
categories[].items[].modifierGroups[].groupIdstring -
categories[].items[].modifierGroups[].minSelectionsinteger -
categories[].items[].modifierGroups[].maxSelectionsinteger -
categories[].items[].modifierGroups[].minUniqueSelectionsinteger -
categories[].items[].modifierGroups[].maxUniqueSelectionsinteger -
categories[].items[].modifierGroups[].freeSelectionCountinteger -
categories[].items[].modifierGroups[].chargeKeptDefaultsboolean -
categories[].items[].modifierGroups[].allowedQuantitiesinteger[] -
categories[].items[].modifierGroups[].optionDefaultsobject[] -
categories[].items[].modifierGroups[].optionDefaults[].optionIdstring -
categories[].items[].modifierGroups[].optionDefaults[].defaultQuantityinteger -
categories[].items[].modifierGroups[].externalIdany -
categories[].items[].modifierGroups[].nameany -
categories[].items[].modifierGroups[].optionsany -
categories[].items[].modifierGroups[].idstring -
categories[].items[].modifierGroups[].inputTypestringOne of
options,text. -
categories[].items[].modifierGroups[].options[].idstring -
categories[].items[].modifierGroups[].options[].externalIdstring -
categories[].items[].modifierGroups[].options[].namestring -
categories[].items[].modifierGroups[].options[].priceobject -
categories[].items[].modifierGroups[].options[].price.amountobject -
categories[].items[].modifierGroups[].options[].price.priceTypestringOne of
fixed,variable,per_unit,bulk. -
categories[].items[].modifierGroups[].options[].price.taxInclusiveboolean -
categories[].items[].modifierGroups[].options[].price.currencyPricesobject[] -
categories[].items[].modifierGroups[].options[].price.openBoundsobject -
categories[].items[].modifierGroups[].options[].price.bulkTiersobject[] -
categories[].items[].modifierGroups[].options[].price.measurementUnitobject -
categories[].items[].modifierGroups[].options[].price.compareAtAmountobject -
categories[].items[].modifierGroups[].options[].defaultQuantityinteger -
categories[].items[].modifierGroups[].options[].minQuantityinteger -
categories[].items[].modifierGroups[].options[].maxQuantityinteger -
categories[].items[].modifierGroups[].options[].taxCategoryIdstring -
categories[].items[].modifierGroups[].options[].taxRateIdsstring[] -
categories[].items[].modifierGroups[].options[].dietaryLabelsstring[] -
categories[].items[].modifierGroups[].options[].allergensstring[] -
categories[].items[].modifierGroups[].options[].stockStatusstringOne of
in_stock,out_of_stock,low_stock. -
categories[].items[].modifierGroups[].options[].modifierGroupsobject[] -
categories[].items[].modifierGroups[].options[].modifierGroups[].groupIdstring -
categories[].items[].modifierGroups[].options[].modifierGroups[].minSelectionsinteger -
categories[].items[].modifierGroups[].options[].modifierGroups[].maxSelectionsinteger -
categories[].items[].modifierGroups[].options[].modifierGroups[].minUniqueSelectionsinteger -
categories[].items[].modifierGroups[].options[].modifierGroups[].maxUniqueSelectionsinteger -
categories[].items[].modifierGroups[].options[].modifierGroups[].freeSelectionCountinteger -
categories[].items[].modifierGroups[].options[].modifierGroups[].chargeKeptDefaultsboolean -
categories[].items[].modifierGroups[].options[].modifierGroups[].allowedQuantitiesinteger[] -
categories[].items[].modifierGroups[].options[].modifierGroups[].optionDefaultsobject[] -
categories[].items[].modifierGroups[].options[].modifierGroups[].externalIdany -
categories[].items[].modifierGroups[].options[].modifierGroups[].nameany -
categories[].items[].modifierGroups[].options[].modifierGroups[].optionsany -
categories[].items[].modifierGroups[].options[].modifierGroups[].idstring -
categories[].items[].modifierGroups[].options[].modifierGroups[].inputTypestringOne of
options,text. -
categories[].items[].modifierGroups[].options[].modifierGroups[].textMaxLengthinteger -
categories[].items[].modifierGroups[].textMaxLengthinteger -
categories[].items[].taxCategoryIdstring -
categories[].items[].taxRateIdsstring[] -
categories[].items[].feeIdsstring[] -
categories[].items[].dietaryLabelsstring[] -
categories[].items[].allergensstring[] -
categories[].items[].calorieCountinteger -
categories[].items[].availabilityobject -
categories[].items[].availability.windowsobject[] required -
categories[].items[].availability.windows[].dayOfWeekinteger required -
categories[].items[].availability.windows[].startTimestring required -
categories[].items[].availability.windows[].endTimestring required -
categories[].items[].stockStatusstringOne of
in_stock,out_of_stock,low_stock.
Errors
-
400Bad request -
401Unauthorized -
403Forbidden -
404Not found -
429Too many requests
Every error body names the error in _tag, explains it in message, and says where to report it in feedback. See Errors.
A 429 also sends Retry-After: Seconds to wait before retrying; also returned as retry_after in the body.