# Modify the available and unavailable status(in batch)

1. Product data that can be transmitted in one batch should not exceed 200. If there are more products, please create them in batches.
2. The interface supports partial synchronization success and partial synchronization failure. However, if there is a parameter format error, all will fail.
3. If there is no available product in a ShopCategory, the ShopCategory will disapear at user APP.
4. If needLinkage=1, this API will also modify the status linked to the ChoiceGroupSkus (the same name with Spu). But if the ChoiceGroupSku status violates the rule of ChoiceGroup, it wouldn't be modified.

 10 QPS by appId dimension.


Endpoint: POST /product/spustatus/batchupdate
Version: v.1.0.0

## Request fields (application/json):

  - `shopId` (integer, required)
    store id in KeeTa
    Example: 25381

  - `spuIdList` (array, required)
    Spu id list
    Example: [1,2,3]

  - `status` (integer, required)
    1 - available 0 - unavailable
    Example: 1

  - `needLinkage` (integer)
    1 - need linkage modification else - no need
    Example: 1

## Response 200 fields (application/json):

  - `code` (integer, required)
    A numeric status identifier indicating the result of the interface call, used to determine whether the operation executed successfully.

  - `message` (string, required)
    Text description corresponding to the status code, explaining the operation result or error cause to users.
    Example: "Success"

  - `data` (array)
    Successful Spu data model

  - `data.id` (integer)
    Unique SPU ID generated by Keeta. Not required in OpenItemCode-based APIs. Required for updates in Keeta ID-based APIs. See "Menu Development Guide" for details.
    Example: 12345

  - `data.name` (string, required)
    Product name
    Example: "Spicy Chicken Burger"

  - `data.sourceLanguageType` (string, required)
    Language code for name field (refer to Menu Integration Guide)
    Example: "en"

  - `data.nameTranslation` (string)
    Localized name translation
    Example: "辣雞腿漢堡"

  - `data.targetLanguageType` (string)
    Language code for nameTranslation (required if translation exists), please refer to [Menu API Integration Guide](./docs/menuIntegrationGuide.md)
    Example: "zh-HK"

  - `data.nameTranslateType` (integer)
    Source of name translation. When the value equals 1, it indicates that the name translation was provided by the merchant.
    Example: 1

  - `data.status` (integer, required)
    Product availability status:
    Example: 1

  - `data.description` (string)
    Product description
    Example: "Spicy Chicken Burger description"

  - `data.descSourceLanguageType` (string)
    Language code for description (required if description exists), please refer to [Menu API Integration Guide](./docs/menuIntegrationGuide.md)
    Example: "en"

  - `data.descriptionTranslation` (string)
    Localized description translation
    Example: "辣雞腿漢堡描述"

  - `data.descTargetLanguageType` (string)
    Language code for descriptionTranslation (required if translation exists), please refer to [Menu API Integration Guide](./docs/menuIntegrationGuide.md)
    Example: "zh-HK"

  - `data.descriptionTranslateType` (integer)
    Source of description translation. When the value equals 1, it indicates that the description translation was provided by the merchant.
    Example: 1

  - `data.shopCategoryList` (array)
    Menu categories this SPU belongs to. The 'id' field is required when not using menuSync API. For all interfaces using this struct except menuSync, the id field in ShopCategory struct is required to associate SPUs with category.

  - `data.shopCategoryList.id` (integer)
    Keeta's menu category ID. Not required for OpenItemCode-based APIs. Required for updates in Keeta ID-based APIs.
    Example: 12345

  - `data.shopCategoryList.name` (string, required)
    Name of the category in a menu
    Example: "Happy Meal"

  - `data.shopCategoryList.sourceLanguageType` (string, required)
    Language type of the name field. Supported language enums can be found in Menu Integration Guide
    Example: "en"

  - `data.shopCategoryList.nameTranslation` (string)
    Translated text for the name field
    Example: "開心樂園餐"

  - `data.shopCategoryList.targetLanguageType` (string)
    Language type of nameTranslation. Required when nameTranslation is provided.
    Example: "zh-HK"

  - `data.shopCategoryList.type` (integer, required)
    Indicates the menu category type:

  - `data.shopCategoryList.description` (string)
    Brief description of the category in a menu
    Example: "Happy Meal description"

  - `data.shopCategoryList.descSourceLanguageType` (string)
    Language type of description. Required if description exists.
    Example: "en"

  - `data.shopCategoryList.descriptionTranslation` (string)
    Translated text for description
    Example: "開心樂園餐描述"

  - `data.shopCategoryList.descTargetLanguageType` (string)
    Language type of descriptionTranslation. Required when descriptionTranslation exists.
    Example: "zh-HK"

  - `data.shopCategoryList.openItemCode` (string, required)
    Third-party category ID. Mandatory and must be unique in OpenItemCode-based APIs. Optional in Keeta ID-based APIs.
    Example: "SHOP_CATEGORY#10001"

  - `data.shopCategoryList.availableTime` (object)
    Selling time slots for this category. Categories are unavailable outside these times.

  - `data.shopCategoryList.availableTime.code` (integer, required)
    Selling time type indicator:

  - `data.shopCategoryList.availableTime.values` (array)
    Required when code=1. Contains 7 strings representing daily time slots (Sunday to Saturday). Empty string means unavailable.

  - `data.shopCategoryList.availableTime.available` (array)
    Defines specific date ranges and time windows. Required when code=2.

  - `data.shopCategoryList.availableTime.available.startTimestamp` (integer)
    Beginning timestamp (milliseconds). Required when using absolute date ranges. If set without endTimestamp, indicates perpetual availability after start date. Required when AvailableTime.code = 2
    Example: 1735660800000

  - `data.shopCategoryList.availableTime.available.endTimestamp` (integer)
    Ending timestamp (milliseconds). When omitted with startTimestamp, creates open-ended availability.
    Example: 1736956799000

  - `data.pictureList` (array)
    Product image URLs

  - `data.pictureList.url` (string, required)
    Product image URLs

  - `data.propertyList` (array)
    SPU specifications (e.g., "Size" options for pizza)

  - `data.propertyList.propertyId` (integer, required)
    Unique identifier for the property
    Example: 9999

  - `data.propertyList.propertyName` (string)
    Display name of the property (e.g., "Size" for pizza)

  - `data.propertyList.propertyType` (integer)
    Property classification:
    Example: 1

  - `data.propertyList.minValueNumber` (integer)
    Minimum number of values that must be selected

  - `data.propertyList.maxValueNumber` (integer)
    Maximum number of values that can be selected

  - `data.propertyList.customizable` (integer)
    Custom value allowance: 0: customizable = 0 prohibits custom values 1: customizable = 1 allows custom text input

  - `data.propertyList.propertyValueList` (array, required)
    List of predefined property values

  - `data.propertyList.propertyValueList.valueId` (integer, required)
    Unique identifier for the property value
    Example: 9999

  - `data.propertyList.propertyValueList.valueName` (string)
    Display name of the property value (e.g., "Large" for pizza size)

  - `data.skuList` (array, required)
    A list includes all SKUs under this SPU

  - `data.skuList.id` (integer)
    Unique SKU ID generated by Keeta system. Not required in OpenItemCode-based APIs. Required for updates in Keeta ID-based APIs. For details, see "Menu Development Guide" for details.
    Example: 12345

  - `data.skuList.spec` (string)
    Specification name (optional for single-spec products)
    Example: "Large"

  - `data.skuList.specTranslation` (string)
    Localized specification translation
    Example: "大份"

  - `data.skuList.targetLanguageType` (string)
    Language code for specTranslation (required if translation exists), please refer to [Menu API Integration Guide](./docs/menuIntegrationGuide.md)
    Example: "zh-HK"

  - `data.skuList.specTranslateType` (string)
    Source of spec translation. When the value equals 1, it indicates that the spec translation was provided by the merchant.
    Example: "1"

  - `data.skuList.price` (string)
    Delivery price (supports 3 decimal places, e.g. "12.33")
    Example: "28.0"

  - `data.skuList.pickPrice` (string)
    Pickup price (supports 3 decimal places)
    Example: "28.0"

  - `data.skuList.canteenPrice` (string)
    Dine-in price (supports 3 decimal places)
    Example: "28.0"

  - `data.skuList.currency` (string)
    Currency code (refer to "Currency Symbols" enum). Defaults to merchant's currency if empty.
    Example: "HKD"

  - `data.skuList.choiceGroupList` (array)
    List of ChoiceGroups associated with this SKU. Not used for menuSync API.

  - `data.skuList.choiceGroupList.id` (integer)
    Unique ChoiceGroup ID generated by Keeta system. Not required in OpenItemCode-based APIs. Required for updates in Keeta ID-based APIs.

  - `data.skuList.choiceGroupList.name` (string, required)
    Display name of the ChoiceGroup
    Example: "Sauces"

  - `data.skuList.choiceGroupList.minNumber` (integer, required)
    Minimum number of ChoiceGroupSkus that must be selected

  - `data.skuList.choiceGroupList.maxNumber` (integer, required)
    Maximum number of ChoiceGroupSkus that can be selected
    Example: 3

  - `data.skuList.choiceGroupList.choiceGroupSkuList` (array, required)
    List of available ChoiceGroupSkus in this ChoiceGroup

  - `data.skuList.choiceGroupList.choiceGroupSkuList.id` (integer)
    Primary key for ChoiceGroupSku, mainly used for order API alignment. Changes when names are modified. Not required in OpenItemCode-based APIs. Required for updates in Keeta ID-based APIs.

  - `data.skuList.choiceGroupList.choiceGroupSkuList.name` (string, required)
    Display name of the ChoiceGroupSku. Should match SPU name when representing the same product for internal correlation.
    Example: "Ketchup"

  - `data.skuList.choiceGroupList.choiceGroupSkuList.price` (string)
    Delivery price (supports 2 decimal places)
    Example: "12.33"

  - `data.skuList.choiceGroupList.choiceGroupSkuList.pickPrice` (string)
    Pickup price (supports 2 decimal places)
    Example: "12.33"

  - `data.skuList.choiceGroupList.choiceGroupSkuList.canteenPrice` (string)
    Dine-in price (supports 2 decimal places)
    Example: "12.33"

  - `data.skuList.choiceGroupList.choiceGroupSkuList.currency` (string)
    Currency code (refer to "Currency Symbols" enum). Defaults to merchant's currency.
    Example: "HKD"

  - `data.skuList.choiceGroupList.choiceGroupSkuList.status` (integer, required)
    Availability status: 
  > 0:  indicates the ChoiceGroupSku is unavailable /
  > 1:  indicates ChoiceGroupSku is available
    Example: 1

  - `data.skuList.choiceGroupList.choiceGroupSkuList.openItemCode` (string, required)
    Third-party ChoiceGroupSku identifier. Mandatory and unique in OpenItemCode-based APIs.
    Example: "CHOICE#10001"

  - `data.skuList.choiceGroupList.choiceGroupSkuList.nutritionalInfo` (object)
    Nutritional components (refer to "Nutritional Elements" enum)

  - `data.skuList.choiceGroupList.choiceGroupSkuList.allergens` (array)
    Allergen information (refer to "Allergens" enum)

  - `data.skuList.choiceGroupList.choiceGroupSkuList.pictureList` (array)
    ChoiceGroupSku image URLs

  - `data.skuList.choiceGroupList.choiceGroupSkuList.pictureList.url` (string, required)
    ChoiceGroupSku image URLs
    Example: "https://img-ap-hongkong.mykeeta.net/sailorproduct/9c760595674b395e330cf94b0e5068b09999.jpg"

  - `data.skuList.choiceGroupList.choiceGroupSkuList.relatedSpuOpenItemCode` (string)
    Third-party SPU identifier this ChoiceGroupSku should bind to. Using this to explicitly bind the ChoiceGroupSku to the given SPU.

  - `data.skuList.choiceGroupList.choiceGroupSkuList.relatedSkuOpenItemCode` (string)
    Third-party SKU identifier this ChoiceGroupSku should bind to. Using this to explicitly bind the ChoiceGroupSku to the given SKU. When a ChoiceGroupSku bind to a SKU, it will use the bounded SKU's ChoiceGroups to form a multi-layer ChoiceGroup structure.

  - `data.skuList.choiceGroupList.openItemCode` (string, required)
    Developer-provided ChoiceGroup identifier. Mandatory and unique in OpenItemCode-based APIs.
    Example: "GROUP#10001"

  - `data.skuList.choiceGroupList.repeatable` (integer)
    Multiple selection flag:

  - `data.skuList.openItemCode` (string, required)
    Developer-provided SKU identifier. Mandatory and unique in OpenItemCode-based APIs. Optional for Keeta-based ID APIs.
    Example: "SKU#10001"

  - `data.skuList.choiceGroupOpenItemCodeList` (array)
    OpenItemCodes of associated ChoiceGroups. Required for menuSync API.

  - `data.availableTime` (object, required)
    Selling time slots for this product

  - `data.isSpecialty` (integer, required)
    Signature dish indicator:

  - `data.openItemCode` (string, required)
    Developer-provided SPU identifier. Mandatory and unique in OpenItemCode-based APIs.
    Example: "SPU#10001"

  - `data.shopCategoryOpenItemCodeList` (array, required)
    This field contains the OpenItemCodes that correspond to menu categories in Keeta's system. When calling the menu synchronization (menuSync) API, this field becomes mandatory. The OpenItemCodes are provided by developers and maintain a one-to-one relationship with Keeta's internal menu category IDs. The Keeta platform will verify whether these OpenItemCodes actually exist in the merchant's store.
    Example: ["2$33419","3$34747"]

  - `data.userGetModeList` (array, required)
    This field specifies the supported order fulfillment modes, with case-sensitive values. By default, all products support "delivery" mode. To enable "pickup" mode, the following conditions must be satisfied: First, every SKU in the skuList must have a valid pickPrice value specified. Second, all options within every choice group associated with these SKUs must also have pickPrice values defined. The system recognizes two mode values: "delivery" for standard food delivery services "pickup" for customer self-collection scenarios
    Example: ["delivery","pickup"]

  - `errorList` (array)
    Failed Spu informations

  - `errorList.id` (integer)
    Unique identifier for the SPU (Standard Product Unit), generated by Keeta's system

  - `errorList.name` (string)
    Display name of the SPU

  - `errorList.openItemCode` (string)
    Developer-provided external identifier that maintains a one-to-one mapping with Keeta's internal SPU ID. Refer to the "Menu Development Guide" for implementation details.
    Example: "VGsku-00035"

  - `errorList.errorPictureList` (array)
    Contains information about failed image binding attempts during batch operations, including error details

  - `errorList.errorPictureList.code` (integer)
    A numeric status identifier indicating the result of the interface call, used to determine whether the operation executed successfully.  indicates that .  indicates that .  can be viewed in the  field.