updateCategory

2023-04-28 21:00

POST /v2/pds/store/updateCategory

With this API call, the SaaS provider or ISV can update an existing category that has been synchronized via the initializeStore or addCategory API, such as making small edits or deleting the category.

To update a category, categoryId is required. Determine which category to update with categoryId, storeId, menuId, and menuType. For more information, refer to Request parameters.
To learn how the update works, check below:
To update a field, pass the field with a new value.
To delete a field, pass the field with an empty object, for example, "" for String, {} for Object, [] for Array. The required fields in the initializeStore or addCategory API cannot be deleted with this API call.
If you do not pass a field, it will not be updated.

Structure

A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see:

Request parameters

Field	Data type	Required	Description	Example
categoryId	String	Yes	Indicates the category ID. Maximum length: 255 characters Note: Passing only the category ID will update multiple categories with the same category ID.	"0000000004"
storeId	String	No	Indicates the ID assigned by the SaaS provider or ISV to identify a store. Maximum length: 255 characters Note: Pass this field to update a specific category for the specified store. Before that, make sure the Store object has been synchronized via the initializeStore or addStore API and is not deleted.	"000000032"
menuId	String	No	Indicates the ID of the menu to which the category belongs. Maximum length: 255 characters Note: Pass this field to update a specific category for the specified menu. Before that, make sure the Menu object has been synchronized via the initializeStore or addMenu API and is not deleted.	"0000000003"
menuType	String	No	Indicates the type of the menu. Valid values are: `PICKUP`: Food that is picked up by users themselves. `DINEIN`: Food that is eaten in the restaurant where it is ordered. `DELIVERY`: Food that requests delivery to a specific destination. Note: Pass this field to update a specific category for the specified menu type. Passing only menuType is not supported, which means menuType must belong to a store or a menu. If you pass menuId and menuType, make sure the menu information for these two fields has been synchronized via the initializeStore or addMenu API.	"PICKUP"
title	String	No	Indicates the title of the category. Maximum length: 255 characters Note: This field should be in English. If multi-language is needed, refer to MultiLanguageDetail.	"Hamburger"
subTitle	String	No	Indicates the subtitle of the category. Maximum length: 255 characters Note: This field should be in English. If multi-language is needed, refer to MultiLanguageDetail.	"Big Hamburger"
icon	String	No	Indicates the icon of the menu. Maximum length: 255 characters	-
multiLanguageDetails	Array<MultiLanguageDetail>	No	Indicates the details of the multi-language content. Maximum size: 20 elements Note: If the MultiLanguageDetail object you pass already exists, it will be updated, otherwise, it will be added.	-
isDeleted	String	No	Indicates whether the category is deleted. The valid value is: `DELETED`: The category is deleted and not visible to users. Once deleted, the category cannot be retrieved. Call the addCategory API to add it back. Note: If the value you set is `DELETED` but the category ID does not exist, `S` is returned, which means the request to delete the category is successful.	"DELETED"

Response parameters

Field	Data type	Required	Description
result	Result	Yes	Indicates the request result, such as status and error codes.

Result process logic

In the response, the result.resultStatus field indicates the result of processing a request. The following table describes each result status:

Result status	Description
S	The category is updated successfully. The corresponding result.resultCode is `SUCCESS` and result.resultMessage is `SUCCESS`.
U	The status of the request to update the category is unknown. The corresponding result.resultCode is `UNKNOWN_EXCEPTION` and result.resultMessage is "An API calling is failed, which is caused by unknown reasons.". For details, see the Common error codes section.
F	Failed to update the category. The corresponding result.resultCode and result.resultMessage may vary based on different situations. For details, see the following Error codes section.

Error codes

Error codes are usually classified into the following categories:

Common error codes are common for F&B mini program OpenAPIs.

Samples

Request

copy
{
    "storeId": "lzteststore75772345",
    "menuId": "M1110",
    "menuType": "PICKUP",
    "categoryId": "100",
    "title": "Others",
    "subTitle": "",
    "icon": "http://www.example.com/iamges/cdZOWIR73/00ACicon.jpg"
}

Response

copy
{
    "result": {
        "resultCode": "SUCCESS",
        "resultStatus": "S",
        "resultMessage": "success"
    }
}