Return Codes

List of Successful Codes

The API uses the following HTTP codes to indicate regular successful returns:

HTTP Status Description HTTP Method
200 Indicates that the processing was correctly performed, and the return may be checked in the HTTP Response body GET
201 Indicates that the resource was successfully created and it must have the header Location: indicating the new resource URI POST
202 Indicates that the processing will be asynchronous, so, besides the header Location, it must return the content with a status attribute POST, PUT e DELETE
204 Indicates that the resource was successfully changed or deleted PUT e DELETE

List of Error Codes

The API uses the following HTTP codes to indicate regular errors:

HTTP Status Description
422 Business exceptions
400 Malformed Request
401 Request needs Authentication
403 Request Denied
404 Resource not Found
405 Method not Allowed
408 Request Timeout
413 Request exceeds the allowed maximum size
415 Invalid media type (correct content-type not informed, see JSON)
429 Request exceed the maximum quantity of allowed calls to the API
500 Server error

The errors mentioned above will be returned in the following pattern:

{
    "errors": [
        {
            "code": "401.001",
            "type": "SecurityException",
            "message": "Você não tem permissão para acessar o recurso desejado",
            "skuSellerId": "" -- campo opcional
        }
    ]
}

Errors list

You will see below the full list of errors returned by the API as of version 2:

Type HTTP Status Code Message
APIGenericError * 999.999 **
APIException 404 404 Resource not Found
405 405 Method not Allowed
415 415 Invalid Media Type
400 400.001 The requested attribute does not exist: NAME_OF_THE_ATTRIBUTE
400 400.002 The informed attribute does not exist or is invalid: NAME_OF_THE_ATTRIBUTE
QueryStringException 400 400.003 queryString parameter with an incorrect format. PATTERN is the correct format for the NAME_OF_THE_ATTRIBUTE attribute
400 400.005 Attribute not informed or invalid: NOME_DO_ATRIBUTO
400 400.010 queryString _offset parameter is mandatory
400 400.011 queryString _offset parameter must be numeric and positive
400 400.020 queryString _limit parameter is mandatory
400 400.021 queryString _limit parameter must be numeric and positive
SecurityException 403 403.001 You are not allowed to access the intended resource
401 401.001 Access Denied - App-token not informed
401 401.002 Access Denied - Auth-token not informed
401 401.003 Access Denied - App-token invalid or nonexistent
401 401.004 Access Denied - Auth-token invalid or nonexistent
ProductLoadsException 400 001.001 skuSellerId field is mandatory
400 001.002 title field is mandatory
400 001.003 description field is mandatory
400 001.004 brand field is mandatory
400 001.005 categories field is mandatory
400 001.007 You must provide at least one image
400 001.008 Image must be a valid URL
400 001.009 price object is mandatory
400 001.010 price.default field is mandatory
400 001.011 price.default field must be numeric
400 001.012 price.offer field is mandatory
400 001.013 price.offer field must be numeric
400 001.014 stock object is mandatory
400 001.015 stock.quantity field is mandatory
400 001.016 stock.quantity field must be numeric
400 001.017 stock.crossDockingTime field must be numeric
400 001.018 dimensions.weight field must be numeric
400 001.019 dimensions.length field must be numeric
400 001.020 dimensions.width field must be numeric
400 001.021 dimensions.height field must be numeric
400 001.022 giftWrap.value field must be numeric
400 001.023 skuSellerId field cannot have more than 30 characters
400 001.024 title field cannot have more than 30 characters
400 001.026 brand field cannot have more than XX characters
400 001.027 You must inform at least one category
400 001.028 Only XX category levels are allowed
400 001.029 categories field cannot have more than XX categories
400 001.030 Only XX images are allowed
400 001.031 The image must be in format X, Y or Z
400 001.032 price.default field cannot be negative
400 001.033 price.offer field cannot be negative
400 001.034 price.offer field cannot be higher than price.default
400 001.035 stock.crossDockingTime field cannot be negative
400 001.036 dimensions.weight field cannot be negative
400 001.037 dimensions.length field cannot be negative
400 001.038 dimensions.width field cannot be negative
400 001.039 dimensions.height field cannot be negative
400 001.040 giftWrap.value field cannot be negative
400 001.041 attributes.name field is mandatory
400 001.042 attributes.name field cannot have more than XX characters
400 001.043 attributes.value field is mandatory
400 001.044 attributes.value field cannot have more than XX characters
400 001.045 attributes field cannot have more than XX attributes
400 001.046 description field cannot have HTML tags: img, iframe, script, object
400 001.047 dimensions.weight field is mandatory
400 001.048 dimensions.length field is mandatory
400 001.049 dimensions.width field is mandatory
400 001.050 dimensions.height field is mandatory
400 001.051 stock.quantity field cannot be negative
400 001.100 The GZIP content was not sent
422 001.101 There is a load already processing, please wait a few seconds
400 001.102 JSON invalid. Check the JSON provided
400 001.105 Operation not allowed. Operation not allowed. The product can be canceled only with the PENDING or ERROR status
400 001.106 Operation not allowed. You are allowed to change only products with import errors
400 001.999 **
SellerItemsStatusException 400 005.001 active field is mandatory
400 005.002 active field must be boolean
400 005.003 The allowed values for the website are: Content of the GET /sites service
400 005.999 **
SellerItemsStockException 400 006.001 quantity field is mandatory
400 006.002 quantity field must be numeric
400 006.003 crossDockingTime field must be numeric
400 006.004 warehouse field must be numeric
400 006.999 **
SellerItemsPriceException 400 007.001 default field is mandatory
400 007.002 default field must be numeric
400 007.003 default field cannot be negative
400 007.010 offer field is mandatory
400 007.011 offer field must be numeric
400 007.012 offer field cannot be negative
400 007.013 offer field cannot be higher than default
400 007.020 The allowed values for the website are: Content of the GET /sites service
422 007.100 Change not allowed. The changed value exceeds the allowed variation limit
400 007.999 **
SellerItemsDimensionsException 400 008.001 weight field must be numeric (kilos)
400 008.002 weight field is mandatory
400 008.011 length field must be numeric (meters)
400 008.012 length field is mandatory
400 008.021 width field must be numeric (meters)
400 008.022 width field is mandatory
400 008.031 height field must be numeric (meters)
400 008.032 height field is mandatory
400 008.999 **
TrackingException 400 009.001 You must inform at least one item in the tracking operation
400 009.011 occurredAt field must be date-time
400 009.021 carrier object is mandatory
400 009.022 carrier.name field is mandatory
400 009.031 invoice object is mandatory
400 009.032 invoice.cnpj field is mandatory
400 009.033 invoice.number field is mandatory
400 009.034 invoice.serie field is mandatory
400 009.035 invoice.accessKey field is mandatory
400 009.036 invoice.accessKey field must have 44 digits
400 009.037 issueAt field must be date-time
400 009.999 **
OrdersException 400 010.001 The allowed values for the website are: Content of the GET /sites service
400 010.999 **
WarehouseException 400 017.001 The allowed values for the website are: Content of the GET /sites service
400 017.999 **
SellerItemsException 400 018.001 The allowed values for the website are: Content of the GET /sites service
400 018.999 **

(*) Status returned according to the non-expected error
(**) Message returned according to the non-expected error

 

English