1b.app
Link copied -

API Brand

Add Brand, method: /api/brand/add/

Parameters

Example:

http://myboxurl/api/brand/add/?login=LOGIN&password=PASSWORD&name=TestBrand&code=123&image=url_image_in_this_place&deskription=Description

Field Type Description Required or not Comment
1 login string Login in BOX system Required field.  
2 password string Password in md5 format Required field. Contact tech support and we will give you a hash for the API
3 name string Brand name Required field.  
4 code string id brand from your system Optional field. This is a unique brand identifier from your system (from your store). If a brand with this id exists, the API will throw an error
7 image array brand image array Optional field. Images should be sent as an array with the full path to them. The system works with the following image formats: jpg, png
8 hidden boolean hidden brand Optional field. By default, the brand is not hidden (hidden = 0)
5 description string brand description Optional field.  

Remove Brand, method: /api/brand/delete/

Parameters

Example:

http://myboxurl/api/brand/delete/?login=LOGIN&password=PASSWORD&code=123&id=321

Field Type Description Required or not Comment
1 login string Login in BOX system Required field.  
2 password string Password in md5 format Required field. Contact tech support and we will give you a hash for the API
3 id integer Brand ID or brand id or code is required Brand code in the BOX system
4 code string Brand ID Brand ID from your system (from your store)

Brand Editing, method: /api/brand/update/

Parameters

Example:

http://myboxurl/api/brand/update/?login=LOGIN&password=PASSWORD&code=1234&name=TestBrand&hidden=1

Field Type Description Required or not Comment
1 login string Login in BOX system Required field.  
2 password string Password in md5 format Required field. Contact tech support and we will give you a hash for the API
3 id integer Brand ID or brand id or code is required Brand code in the BOX system
4 code string Brand ID Brand ID from your system (from your store)
5 name string Brand name Required field.  
6 description string brand description Optional field.  
8 image array brand image array Optional field. Images should be sent as an array with the full path to them. The system works with the following image formats: jpg, png
9 hidden boolean hidden brand Optional field. By default, the brand is not hidden (hidden = 0)

Get one brand and get all brands, method: /api/brand/get/

Parameters
Parameters for receiving one order:

Example:

http://myboxurl/api/brand/get/?login=LOGIN&password=PASSWORD&name=TestBrand

Field Type Description Required or not Comment
1 login string Login in BOX system Required field.  
2 password string Password in md5 format Required field. Contact tech support and we will give you a hash for the API
3 name string Brand name name or brand id or code is required If you need a specific brand, then you pass the brand name in this field, or the brand id that was returned to you by our API when it was created. Alternatively, enter the external brand identifier (field code when creating a brand) and the engine will find and return it by itself.

Return field values
id - id brand,
name - Brand name,
code - external brand id,
image - brand image array,
description - brand description,
hidden - hidden brand
4 id integer Brand ID
4 code string Brand ID


Parameters for receiving all orders:

Example:

http://myboxurl/api/brand/get/?login=LOGIN&password=PASSWORD

Field Type Description Required or not Comment
1 login string Login in BOX system Required field.  
2 password string Password in md5 format Required field. Contact tech support and we will give you a hash for the API
          Return field values
id - id brand,
name - Brand name,
code - external brand id,
image - brand image array,
description - brand description,
hidden - hidden brand

Possible responses to the request

More details
Status Message Message Description
1 ok brandid Returns the added brand id
2 fail Login is empty! Login missing
3 fail Password is empty! Missing password
4 fail Brand name is empty! Missing brand name
5 fail Bad user level! Insufficient user level (requires level 2 or higher)
6 fail Login or password not correct! Login or password entered incorrectly
7 fail Brand with this ID already exists! A brand with this id already exists
8 fail Incorrect picture! Invalid image format
9 fail Brand has not been added The brand has not been added
10 fail Brand is not available for delete! Brand not found to delete
11 fail Brand with this ID does not exists! There is no brand with this ID
12 fail Brand with this Code does not exists! There is no brand with this code
13 fail Brand with this name does not exists! There is no brand with this name
14 fail Brand is not available for update! No brand found to update

Errors may also occur:

502 Bad Gateway - If this error occurs it is necessary:
1. Check if you have internet access (go to any other site).
2. If there are no problems with access — cookies can be deleted.
If the above doesn't work — server side problem. Please contact your site system administrator.

503 (Service Temporarily Unavailable) - this error may occur as a result of too many server requests. If you see this error, you should wait a couple of minutes and try again.

504 Gateway Timeout - cmost likely the reason is the increased load on the site, in which Apache is not has time to send HTTP responses and new requests are queued. You can add resources to the server, in particular RAM, and increase the number of httpd (Apache) processes.
Another possible reason for error 504 is that the executable script does not fit within the allotted limit time. This happens when the request is too heavy. Try to split your request into a few more small.

Error 505 HTTP Version not supported means the website is not Supports the version of the HTTP protocol that the browser uses to request a web page