Catalog Namespace
The catalog namespace contains the resource to manage categories and products.
| Operation | Method | Endpoint | Scope | Sample | Description |
| Get Catalog Info | Get | catalog/info/catalog_id | Catalog | Sample | Get Catalog Info |
| Inquiry Catalog | Get | catalog/inquiry | Catalog | Sample | Inquiry Catalog |
| Stock Inquiry | Get | stock/inquiry | Catalog | Sample | Stock Inquiry |
| Search Catalog | Get | catalog/search/catalog_id | Catalog | Sample | Search Catalog |
| Get Catalog History | Get | info/catalog_id | Catalog | Sample | Get Catalog History |
| Get Catalog History Latest | Get | history/latest/catalog_id | Catalog | Sample | Get Catalog History Latest |
Data Object
| Field Name | Field Type | Regular Expression | Sample | Field Status | |||
| POST | PUT | GET | DELETE | ||||
| catalog_search | |||||||
| category Security Type: None |
Object | None | O | O | O | O | |
| product Security Type: None |
Object | None | O | O | O | O | |
| variant Security Type: None |
Object | None | O | O | O | O | |
| notes Security Type: None |
Object | None | O | O | O | O | |
| last_activity Security Type: None |
Object | None | NA | O | NA | NA | |
| authentication Security Type: None |
Object | None | O | O | O | O | |
| validate Security Type: None |
String | ^[0-1]{1,1}$ | 1, 0 | NA | NA | NA | NA |
| category | |||||||
| info Security Type: None |
Object | None | O | O | O | O | |
| seo Security Type: None |
Object | None | O | O | O | O | |
| access_control Security Type: None |
Object | None | O | O | O | O | |
| picture Security Type: None |
Object | None | O | O | O | O | |
| product | |||||||
| info Security Type: None |
Object | None | O | O | O | O | |
| seo Security Type: None |
Object | None | O | O | O | O | |
| related_products Security Type: None |
Object | None | O | O | O | O | |
| cross_sell Security Type: None |
Object | None | O | O | O | O | |
| picture Security Type: None |
Object | None | O | O | O | O | |
| features Security Type: None |
Object | None | O | O | O | O | |
| reviews Security Type: None |
Object | None | O | O | O | O | |
| access_control Security Type: None |
Object | None | O | O | O | O | |
| advanced_options Security Type: None |
Object | None | O | O | O | O | |
| custom_forms Security Type: None |
Object | None | O | O | O | O | |
| notes | |||||||
| user_notes Security Type: None |
String | ^$|(^(?!.*--)[?-?a-zA-Z0-9][^\^+=<>|\n\r\b\t]{0,255}$) | Abc000000 | O | O | O | O |
| admin_notes Security Type: None |
String | ^$|(^(?!.*--)[?-?a-zA-Z0-9][^\^+=<>|\n\r\b\t]{0,255}$) | Abc000000 | O | O | O | O |
| last_activity | |||||||
| entity Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | O | NA | NA |
| entity_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | O | NA | NA |
| entity_data Security Type: None |
Integer | ^[0-9]{1,3}$ | 900 | NA | O | NA | NA |
| activity_type Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | O | NA | NA |
| notes Security Type: None |
Object | None | NA | O | NA | NA | |
| update_date_utc Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01]){1,22}$ | 1992-01-12 (yyyy-mm-dd) | NA | O | NA | NA |
| authentication | |||||||
| type Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | O | O | O | O |
| code Security Type: Encrypted |
String | ^[ A-Za-z0-9_.\/#=&+-]*$ | UN7C-KKT98L-4HAU | O | O | O | O |
| catalog_search_results | |||||||
| id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
| type Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | NA | NA | NA | NA |
| name Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ | Abc00, fʁɑ̃s123 | NA | NA | NA | NA |
| description Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{1,8000}$ | Abc00, fʁɑ̃s123 | NA | NA | NA | NA |
| has_sub_category Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | NA | NA | NA | NA |
| category_localization Security Type: None |
Object | None | NA | NA | NA | NA | |
| product_localization Security Type: None |
Object | None | NA | NA | NA | NA | |
| variant_localization Security Type: None |
Object | None | NA | NA | NA | NA | |
| category_localization | |||||||
| language_code Security Type: None |
String | ^[a-zA-Z]{1,2}(-[a-zA-Z]{1,2})?$ | EN, en, en-ca | NA | NA | NA | NA |
| Id Security Type: None |
Integer | None | O | O | O | O | |
| locatization_name Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ | Abc00, fʁɑ̃s123 | NA | NA | NA | NA |
| description Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{1,8000}$ | Abc00, fʁɑ̃s123 | NA | NA | NA | NA |
| language_name Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{1,8000}$ | Abc00, fʁɑ̃s123 | O | O | O | O |
| language_iso Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{1,8000}$ | Abc00, fʁɑ̃s123 | O | O | O | O |
| language_culture Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{1,8000}$ | Abc00, fʁɑ̃s123 | O | O | O | O |
| product_localization | |||||||
| language_code Security Type: None |
String | ^[a-zA-Z]{1,2}(-[a-zA-Z]{1,2})?$ | EN, en, en-ca | NA | NA | NA | NA |
| Id Security Type: None |
Integer | None | O | O | O | O | |
| locatization_name Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ | Abc00, fʁɑ̃s123 | NA | NA | NA | NA |
| short_description Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{1,8000}$ | Abc00, fʁɑ̃s123 | NA | NA | NA | NA |
| language_name Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{1,8000}$ | Abc00, fʁɑ̃s123 | O | O | O | O |
| language_iso Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{1,8000}$ | Abc00, fʁɑ̃s123 | O | O | O | O |
| language_culture Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{1,8000}$ | Abc00, fʁɑ̃s123 | O | O | O | O |
| full_description Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{1,8000}$ | Abc00, fʁɑ̃s123 | NA | NA | NA | NA |
| variant_localization | |||||||
| language_code Security Type: None |
String | ^[a-zA-Z]{1,2}(-[a-zA-Z]{1,2})?$ | EN, en, en-ca | NA | NA | NA | NA |
| Id Security Type: None |
Integer | None | O | O | O | O | |
| locatization_name Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ | Abc00, fʁɑ̃s123 | NA | NA | NA | NA |
| description Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{1,8000}$ | Abc00, fʁɑ̃s123 | NA | NA | NA | NA |
| language_name Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{1,8000}$ | Abc00, fʁɑ̃s123 | O | O | O | O |
| language_iso Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{1,8000}$ | Abc00, fʁɑ̃s123 | O | O | O | O |
| language_culture Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{1,8000}$ | Abc00, fʁɑ̃s123 | O | O | O | O |
| usage_instructions Security Type: None |
String | None | O | O | O | O | |
Query Parameters
| Field Name | Field Type | Regular Expression | Sample | Field Status | |||
| POST | PUT | GET | DELETE | ||||
| retrieve_catalog_info | |||||||
| type Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | NA | NA | NA | NA |
| entity_id Security Type: None |
String | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
| start_index Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
| page_size Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
| product_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | O | O | O | O |
| program_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
| country_code Security Type: None |
Integer | ^[0-9]{1,3}$ | 900 | NA | NA | NA | NA |
| user_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
| pos_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | O | O | O | O |
| search_term Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ | Abc00, fʁɑ̃s123 | NA | NA | NA | NA |
| currency_code Security Type: None |
String | ^[a-zA-Z0-9-]{1,20}$ | Abc00000 | O | O | O | O |
| store_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
| role_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | O | O | O | O |
| sort_by Security Type: None |
String | ^[a-zA-Z0-9_]{1,22}$ | create_time | O | O | O | O |
| sort_flag Security Type: None |
String | ^(asc|desc)$ | asc, desc | O | O | O | O |
Get Catalog Info
Get Catalog Info
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Inquiry Catalog
Inquiry Catalog
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Stock Inquiry
Stock Inquiry
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Search Catalog
Search Catalog
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Get Catalog History
Get Catalog History
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Get Catalog History Latest
Get Catalog History Latest
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|