Update Catalogue

POST

/open/catalogue/update

Update Catalogue

This API will enable you to Update catalogue.

Request Body Parameters:

Name	Type	Description
api_key	string	Your API-key
user_id	number	User id.
marketplace_user_id	number	Marketplace user id.
catalogue_id	number	Catalogue id
image_url	string(optional)	Image URL.
description_json	object(optional)	"en" is mandatory and refer to below language table.
is_side_order	number	1 to enable side order else 0.
name	string	Name of catalogue
name_json	object	"en" is mandatory and refer to below language table.

Languages

Different languages supported. If you are not passing any languages then it is mandatory to pass "en"

Name	Type
ENGLISH	en
ARABIAN	ar
FRENCH	fr
SPANISH	es
MALAY	ms
SIMPLIFIED_CHINESE	zh-Hans
PORTUGUESE	pt
TRADITIONAL_CHINESE	zh-Hant
BENGALI	bn
MEXICAN_SPANISH	es-mx
KHMER	km
TAMIL	ta
SINHALA	si
SWEDISH	sv

Request

Body Params application/json

object {0}

Example

{
    "api_key"               : {{apikey}},
    "marketplace_user_id"   : 510001,
    "user_id"               : 510001,
    "catalogue_id"          : 1234,
    "image_url"             : [],
    "name"                  : "Pizza",
    "is_side_order"         : 0,
    "name_json"             : {
                        "en": "Pizza"
                              },
    "description_json"      : {
                        "en": ""
                              }
   
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.yelo.red/open/catalogue/update' \
--header 'Content-Type: application/json' \
--data-raw '{
    "api_key"               : {{apikey}},
    "marketplace_user_id"   : 510001,
    "user_id"               : 510001,
    "catalogue_id"          : 1234,
    "image_url"             : [],
    "name"                  : "Pizza",
    "is_side_order"         : 0,
    "name_json"             : {
                        "en": "Pizza"
                              },
    "description_json"      : {
                        "en": ""
                              }
   
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}

Modified at 2024-04-17 07:11:33

Add Catalogue

Get Catalogue

Update Catalogue

Update Catalogue#

This API will enable you to Update catalogue.#

Languages#

Request

Request samples

Responses

Update Catalogue

This API will enable you to Update catalogue.

Languages