Logo

Documentation

Carte en cours du clonage...

Merci d'attendre la fin du clonage avant de modifier quoi que ce soit.

API ERRORS RESPONSES

API errors responses

Foxorder's API includes an error management system, this system allows users to have assistance in case of error.

Depending on the type of errors, the error message is often explicit (typing, null, format, etc.) otherwise, it indicates the source of the error and possibly the solution.

Logo
Endpoint Method Error code => message
/api/v2/menus/{id}/products
GET
  • 401
    => Not allowed
  • 404
    => Menu not found
/api/v2/products/menu
POST
  • 401
    => Invalid User
  • 400
    => Shop not found
  • 400
    => Menu not found
  • 400
    => Product not found
  • 400
    => Locale not found
  • 400
    => Invalid input
    • shop
      • => The entity does not belong to this shop.
      • => A shop is required.
    • locale
      • => At least one locale is required.
      • => The selected locale (eg. es_ES) is invalid.
      • => Duplicated locale.
    • menu
      • => At least one menu is required.
      • => The menu with id (identifier) does not belong to this shop.
    • mode
      • => The selected mode is invalid.
      • => Duplicated mode for this product.
    • category
      • => The selected product category is invalid.
      • => At least one product category is required.
      • => Duplicated product category for this product.
      • => One or more categories disabled.
    • step
      • => constraint.product.step.empty.
    • stepItem
      • => Invalid product type.
      • => The selected shop is invalid.
      • => This product is disabled.
/api/v2/products/simple
POST
  • 401
    => Invalid User
  • 400
    => Shop not found
  • 400
    => Menu not found
  • 400
    => Product not found
  • 400
    => Locale not found
  • 400
    => Invalid input
    • shop
      • => The entity does not belong to this shop.
      • => A shop is required.
    • locale
      • => At least one locale is required.
      • => The selected locale (eg. es_ES) is invalid.
      • => Duplicated locale.
    • menu
      • => At least one menu is required.
      • => The menu with id (identifier) does not belong to this shop.
    • mode
      • => The selected mode is invalid.
      • => Duplicated mode for this product.
    • category
      • => The selected product category is invalid.
      • => At least one product category is required.
      • => Duplicated product category for this product.
      • => One or more categories disabled.
    • option
      • => The provided option is invalid.
/api/v2/products/{id}
GET
  • 401
    => Not allowed
  • 404
    => Product not found
/api/v2/products/{id}
DELETE
  • 401
    => Invalid User
  • 400
    => Invalid input
    • shop
      • => The entity does not belong to this shop.
      • => A shop is required.
  • 422
    => Unprocessable entity
  • 404
    => Resource not found
/api/v2/products/{id}/attach-image
POST
  • 401
    => Access Denied
  • 400
    => Image file is required
  • 400
    => Invalid input
  • 404
    => Resource not found
  • 422
    => Unprocessable entity
/api/v2/products/{id}/simple
PUT
  • 401
    => Invalid User
  • 400
    => Shop not found
  • 400
    => Menu not found
  • 400
    => Resource not found
  • 400
    => Product not found
  • 400
    => Locale not found
  • 400
    => Invalid input
    • shop
      • => The entity does not belong to this shop.
      • => A shop is required.
    • locale
      • => At least one locale is required.
      • => The selected locale (eg. es_ES) is invalid.
      • => Duplicated locale.
    • menu
      • => At least one menu is required.
      • => The menu with id (identifier) does not belong to this shop.
    • mode
      • => The selected mode is invalid.
      • => Duplicated mode for this product.
    • category
      • => The selected product category is invalid.
      • => At least one product category is required.
      • => Duplicated product category for this product.
      • => One or more categories disabled.
    • option
      • => The provided option is invalid.
/api/v2/products/{id}/options
GET
  • 401
    => Invalid User
  • 400
    => Resource not found
/api/v2/products/{id}/menu
PUT
  • 401
    => Invalid User
  • 400
    => Shop not found
  • 400
    => Menu not found
  • 400
    => Resource not found
  • 400
    => Product not found
  • 400
    => Locale not found
  • 400
    => Invalid input
    • shop
      • => The entity does not belong to this shop.
      • => A shop is required.
    • locale
      • => At least one locale is required.
      • => The selected locale (eg. es_ES) is invalid.
      • => Duplicated locale.
    • menu
      • => At least one menu is required.
      • => The menu with id (identifier) does not belong to this shop.
    • mode
      • => The selected mode is invalid.
      • => Duplicated mode for this product.
    • category
      • => The selected product category is invalid.
      • => At least one product category is required.
      • => Duplicated product category for this product.
      • => One or more categories disabled.
    • step
      • => constraint.product.step.empty.
    • stepItem
      • => Invalid product type.
      • => The selected shop is invalid.
      • => This product is disabled.
Loading…
Loading the web debug toolbar…
Attempt #