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
ALIMENT
/api/v2/aliments
GET
CATEGORY
/api/v2/categories
POST
  • 400
    => Invalid User
  • 404
    => Shop not found
  • 404
    => Menu not found
  • 400
    => Category's depth limit reached
  • 400
    => Parent category invalid
  • 400
    => Invalid input
  • 422
    => Unprocessable entity
/api/v2/categories/{id}
GET
  • 403
    => Not allowed
  • 404
    => Resource not found
  • 404
    => Category not found
/api/v2/categories/{id}
PUT
  • 400
    => Invalid User
  • 404
    => Shop not found
  • 404
    => Menu not found
  • 400
    => Category's depth limit reached
  • 400
    => Parent category invalid
  • 400
    => Invalid input
  • 404
    => Resource not found
  • 422
    => Unprocessable entity
/api/v2/categories/{id}
DELETE
  • 400
    => Invalid User
  • 400
    => Invalid Shop
  • 404
    => Resource not found
/api/v2/categories/{id}/attach-image
POST
  • 401
    => Access Denied
  • 400
    => Image file is required
  • 400
    => Invalid input
  • 404
    => Resource not found
  • 422
    => Unprocessable entity
/api/v2/menus/{id}/categories
GET
  • 403
    => Not allowed
  • 404
    => Menu not found
CLOSING DAYS
/api/v2/closing_days/sync
GET
  • 401
    => Invalid User
  • 400
    => Bad Request
  • 400
    => Invalid Date
  • 404
    => Shop not found
  • 404
    => Franchise not found
  • 404
    => Menu not found
CONTACT
/api/v2/contacts
POST
  • 401
    => Invalid User
  • 422
    => Please enter a first name
  • 422
    => Please enter a last name
  • 422
    => Please enter an email
  • 422
    => email: invalid
  • 422
    => Please enter a phone
  • 422
    => phone: format is invalid
  • 422
    => Please enter a message
  • 400
    => Shop's email is missing
  • 400
    => Email send failed
  • 404
    => Invalid input
  • 422
    => Unprocessable entity
CUSTOMER
/api/v2/customers
POST
  • 400
    => Invalid input
  • 422
    => Unprocessable entity
  • 400
    => Invalid input
    • phone
      • => Invalid format.
      • => already used
      • => This value should not be blank.
    • email
      • => already used
      • => Invalid format
    • password
      • => Must contain at least one lowercase letter, one uppercase letter, one number, one special character and a minimum of 8 characters
    • locale
      • => The selected locale (eg. es_ES) is invalid.
    • franchise
      • => Unauthorized locale (eg. de_DE).
    • proof_token
      • => The value is not valid.
/api/v2/customers/authenticate/google
POST
  • 400
    => Google authentication Failed
  • 400
    => Invalid input
    • apiCode
      • => This field is required.
    • redirectUri
      • => This field is required.
      • => The URL "{{ value }}" is not a valid URL
    • qoodosSubscription
      • => This value should be a boolean.
    • qoodosEmailNotification
      • => This value should be a boolean.
    • qoodosPhoneNotification
      • => This value should be a boolean.
/api/v2/customers/authenticate/apple
POST
  • 400
    => Apple authentication Failed
  • 400
    => Invalid input
    • apiCode
      • => This field is required.
    • redirectUri
      • => This field is required.
      • => The URL "{{ value }}" is not a valid URL
    • qoodosSubscription
      • => This value should be a boolean.
    • qoodosEmailNotification
      • => This value should be a boolean.
    • qoodosPhoneNotification
      • => This value should be a boolean.
/api/v2/customers/password-reset
PATCH
  • 400
    => Bad Request
  • 400
    => Invalid input
  • 404
    => Not Found
  • 422
    => Unprocessable entity
/api/v2/customers/password-reset/check-token
GET
  • 400
    => Bad Request
  • 404
    => Not Found
/api/v2/customers/password-reset/request
POST
  • 400
    => Bad Request
  • 400
    => Missing parameters
  • 400
    => Invalid URL
  • 400
    => Email send failed
  • 400
    => Customer not found
  • 422
    => Unprocessable entity
/api/v2/customers/qoodos-subscription
POST
  • 400
    => Bad Request
  • 422
    => Unprocessable entity
/api/v2/customers/qoodos-unsubscription
DELETE
  • 400
    => Bad Request
/api/v2/customers/search
POST
  • 400
    => Invalid input
    • email
      • => This field is required.
      • => Invalid format
    • phone
      • => Invalid format.
    • franchise
      • => This field is required.
      • => The franchise ID is invalid.
/api/v2/customers/subscribe-existing
PATCH
  • 400
    => Bad Request
  • 404
    => Not Found
  • 422
    => Unprocessable entity
/api/v2/customers/{id}
GET
  • 404
    => Resource not found
/api/v2/customers/{id}
PUT
  • 400
    => Bad Request
  • 404
    => Resource not found
  • 422
    => Unprocessable entity
  • 400
    => Invalid input
    • phone
      • => Invalid format.
      • => already used
      • => This value should not be blank.
    • email
      • => already used
      • => Invalid format
    • password
      • => Must contain at least one lowercase letter, one uppercase letter, one number, one special character and a minimum of 8 characters
    • locale
      • => The selected locale (eg. es_ES) is invalid.
    • franchise
      • => Unauthorized locale (eg. de_DE).
    • proof_token
      • => The value is not valid.
/api/v2/customers/{id}/attach-image
POST
  • 401
    => Access Denied
  • 400
    => Image file is required
  • 400
    => Invalid input
  • 404
    => Resource not found
  • 422
    => Unprocessable entity
/api/v2/customers/{id}/set-default-language
PATCH
  • 400
    => Bad Request
  • 404
    => Not Found
  • 422
    => Unprocessable entity
  • 422
    => defaultLanguage: Invalid locale code
/api/v2/customers/{id}/update-password
PATCH
  • 404
    => Not Found
  • 400
    => Bad Request
  • 400
    => The given password is wrong
  • 400
    => Invalid input
  • 404
    => Resource not found
  • 422
    => Unprocessable entity
  • 400
    => Invalid input
    • password
      • => Must contain at least one lowercase letter, one uppercase letter, one number, one special character and a minimum of 8 characters
DELIVERY ADDRESS
/api/v2/delivery_addresses
POST
  • 400
    => Invalid User
  • 400
    => Invalid input
  • 400
    => Maximum delivery address have been exceeded : 5
  • 400
    => Postal code is missing
  • 400
    => Invalid Building type
  • 400
    => Delivery address's label already exist
/api/v2/delivery_addresses/{id}
PUT
  • 400
    => Invalid User
  • 400
    => Invalid input
  • 400
    => Maximum delivery address have been exceeded : 5
  • 400
    => Postal code is missing
  • 400
    => Invalid Building type
  • 400
    => Delivery address's label already exist
/api/v2/delivery_addresses/{id}
DELETE
  • 404
    => Resource not found
/api/v2/delivery_addresses/{id}/set-default
PATCH
  • 400
    => Invalid input
  • 400
    => Delivery address is missing
  • 404
    => Resource not found
DEVICE
/api/v2/devices
GET
  • 403
    => Access Denied
  • 400
    => Franchise's token or shop's token is required
  • 400
    => Invalid token
  • 400
    => Invalid device's token
  • 401
    => Unrecognized device
/api/v2/devices/pair
POST
  • 403
    => Access Denied
  • 400
    => Missing parameters
  • 400
    => Invalid PIN Code
  • 400
    => Already paired
  • 401
    => Paired with other device
/api/v2/devices/{id}/paired
GET
  • 403
    => Access Denied
/api/v2/devices/{id}
GET
  • 403
    => Access Denied
  • 404
    => Device not found
/api/v2/devices/{token}/enable
PATCH
  • 401
    => Access Denied
  • 400
    => Invalid input
  • 422
    => Unprocessable entity
  • 406
    => Not Acceptable
  • 404
    => Device not found
/api/v2/devices/{token}/disable
PATCH
  • 401
    => Access Denied
  • 400
    => Invalid input
  • 422
    => Unprocessable entity
  • 406
    => Not Acceptable
  • 404
    => Device not found
FRANCHISE
/api/v2/franchises/domain
GET
  • 401
    => Invalid User
  • 400
    => Media's image is required
  • 400
    => Bad Request
  • 404
    => RESOURCE_NOT_FOUND
  • 403
    => BLOCKED_ACCOUNT
LOCALE
/api/v2/locales
GET
LOYALTY
/api/v2/loyalty/{id}/configuration
GET
  • 400
    => Loyalty API is not reachable
  • 400
    => Unexpected error occurred
  • 404
    => Resource not found
  • 400
    => Bad Request
/api/v2/loyalty/{customerId}/benefits
GET
  • 400
    => Loyalty API is not reachable
  • 400
    => Unexpected error occurred
  • 404
    => Resource not found
/api/v2/loyalty/customers
POST
  • 400
    => Unexpected error occurred
  • 400
    => Bad request
  • 400
    => Invalid input
    • email
      • => Invalid format
    • phone
      • => Invalid format.
      • => The phone number must be a valid mobile number.
    • optinSms
      • => This value should be a boolean.
    • optinEmail
      • => This value should be a boolean.
    • loyalty_customer
      • => An email address or phone number is required.
/api/v2/loyalty/customers/search
POST
  • 400
    => Loyalty API is not reachable
  • 400
    => Unexpected error occurred
  • 404
    => Loyalty customer not found
  • 400
    => Bad request
  • 400
    => Invalid input
    • email
      • => Invalid format
    • phone
      • => Invalid format.
      • => The phone number must be a valid mobile number.
    • loyalty_customer
      • => An email address or phone number is required.
/api/v2/loyalty/customers/{customerId}
PATCH
  • 400
    => Invalid input
    • loyalty_customer
      • => An optin sms or email is required.
MENU
/api/v2/menus
GET
  • 403
    => Not allowed
  • 400
    => Shop id is missing
  • 404
    => Shop not found
/api/v2/menus
POST
  • 403
    => Not allowed
  • 400
    => Invalid input
  • 400
    => Invalid User
  • 404
    => Shop not found
  • 422
    => Unprocessable entity
/api/v2/menus/create
POST
  • 403
    => Not allowed
  • 400
    => Invalid json
  • 400
    => Invalid menu json
  • 400
    => Missing category fields
  • 400
    => Category fields are empty
  • 400
    => Category's image invalid
  • 400
    => Category already exist
  • 400
    => Products mismatch between menu and provided product list
  • 400
    => Categories mismatch between categories and provided categories inside products
  • 400
    => Missing product fields
  • 400
    => Product fields are empty
  • 400
    => Product's image invalid
  • 400
    => Product already exist
  • 400
    => Invalid product component
  • 400
    => Missing option fields
  • 400
    => Option fields are empty
  • 400
    => Invalid option type
  • 400
    => Option's image invalid
  • 400
    => Missing option variant fields
  • 400
    => Option variant fields are empty
  • 400
    => Option variant's image invalid
  • 400
    => Option already exist
  • 400
    => Invalid map products fields id
  • 400
    => Invalid map product field cross selling
  • 400
    => Invalid map product field up selling
  • 400
    => Missing categories in products
/api/v2/menus/{id}
GET
  • 403
    => Not allowed
  • 404
    => Menu not found
  • 404
    => Resource not found
/api/v2/menus/{id}
PUT
  • 403
    => Not allowed
  • 400
    => Invalid input
  • 400
    => Invalid User
  • 404
    => Shop not found
  • 404
    => Resource not found
  • 422
    => Unprocessable entity
/api/v2/menus/{id}
DELETE
  • 403
    => Not allowed
  • 400
    => Invalid input
  • 400
    => Invalid User
  • 400
    => Invalid Shop
  • 404
    => Resource not found
/api/v2/menus/{id}/categories
GET
  • 403
    => Not allowed
  • 404
    => Resource not found
/api/v2/menus/{id}/cross-selling-products
GET
  • 403
    => Not allowed
  • 404
    => Menu not found
/api/v2/menus/{id}/enable
PATCH
  • 403
    => Not allowed
  • 404
    => Menu not found
/api/v2/menus/{id}/products
GET
  • 403
    => Not allowed
  • 404
    => Resource not found
/api/v2/menus/{id}/promotional-offers
GET
  • 400
    => Only category or product should be given
  • 404
    => Menu not found
  • 401
    => Unauthorized
  • 404
    => Resource not found
/api/v2/menus/{id}/update
POST
  • 403
    => Not allowed
  • 404
    => Menu not found
  • 400
    => Invalid json
  • 400
    => Invalid menu json
  • 400
    => Missing category fields
  • 400
    => Category fields are empty
  • 400
    => Category already exist
  • 400
    => Products mismatch between menu and provided product list
  • 400
    => Categories mismatch between categories and provided categories inside products
  • 400
    => Missing product fields
  • 400
    => Product fields are empty
  • 400
    => Product already exist
  • 400
    => Invalid product component
  • 400
    => Missing option fields
  • 400
    => Option fields are empty
  • 400
    => Invalid option type
  • 400
    => Option's image invalid
  • 400
    => Option variant fields are empty
  • 400
    => Option already exist
  • 400
    => Invalid map products fields id
  • 400
    => Invalid map product field cross selling
  • 400
    => Invalid map product field up selling
  • 400
    => Missing categories in products
OPENING HOURS
/api/v2/opening_hours/sync
GET
  • 401
    => Invalid User
  • 400
    => Bad Request
  • 400
    => Invalid Date
  • 404
    => Shop not found
  • 404
    => Franchise not found
  • 404
    => Menu not found
OPTION
/api/v2/options
POST
  • 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.
    • type
      • => Invalid option type.
    • product
      • => The provided product with id (eg. 1010) does not belong to this shop.
    • menu
      • => At least one menu is required.
      • => The menu with id (identifier) does not belong to this shop.
  • 422
    => Unprocessable entity
/api/v2/options/{id}
GET
  • 401
    => Resource not found
  • 403
    => Not allowed
  • 404
    => Option not found
/api/v2/options/{id}
PUT
  • 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.
    • type
      • => Invalid option type.
    • product
      • => The provided product with id (eg. 1010) does not belong to this shop.
    • menu
      • => At least one menu is required.
      • => The menu with id (identifier) does not belong to this shop.
  • 404
    => Resource not found
  • 422
    => Unprocessable entity
/api/v2/options/{id}
DELETE
  • 400
    => Invalid User
  • 400
    => Invalid Shop
  • 404
    => Resource not found
/api/v2/options/{id}/attach-image
POST
  • 401
    => Access Denied
  • 400
    => Image file is required
  • 400
    => Invalid input
  • 404
    => Resource not found
  • 422
    => Unprocessable entity
OPTION VARIANT
/api/v2/option_variants
POST
  • 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.
  • 422
    => Unprocessable entity
/api/v2/option_variants/{id}
GET
  • 404
    => Resource not found
/api/v2/option_variants/{id}
PUT
  • 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.
  • 404
    => Resource not found
  • 422
    => Unprocessable entity
/api/v2/option_variants/{id}
DELETE
  • 403
    => Not allowed
  • 404
    => Resource not found
/api/v2/option_variants/{id}/attach-image
POST
  • 401
    => Access Denied
  • 400
    => Image file is required
  • 400
    => Invalid input
  • 404
    => Resource not found
  • 422
    => Unprocessable entity
ORDER
/api/v2/orders
GET
  • 400
    => Bad Request
  • 400
    => Invalid Date
  • 403
    => Not allowed
/api/v2/orders
POST
  • 400
    => Invalid input
    • shop
      • => This field is required.
    • locale
      • => At least one locale is required.
      • => The selected locale (eg. es_ES) is invalid.
      • => Duplicated locale.
    • device
      • => Tokens shop's entity & shop's device do not match.
      • => This mode is not allowed on this device.
    • date
      • => This value should not be null.
      • => ASAP date is incorrect.
      • => Invalid order's date.
      • => Future date is invalid.
      • => Minimum number of days not met.
      • => Exceeds maximum number of days allowed.
      • => The order date minutes must be a multiple of the shop's order interval.
      • => The order date cannot be ASAP.
      • => Shop closed.
      • => Maximum orders for this slot has been reached. Please pick an other slot.
      • => Maximum products used in this slot has been reached. Please pick an other slot.
      • => Ordering hours are incorrect.
      • => Pickup hours are incorrect.
      • => This field is required.
    • tableNumber
      • => Table's number is missing.
    • customerName
      • => Customer's name is missing.
    • qoodosRewards
      • => Invalid free item data (id => %code%, sku => %sku%).
      • => Invalid Qoodos reward.
      • => Invalid Qoodos discount.
    • promotion
      • => Guests are not allowed.
      • => Minimum order amount not reached for promotion.
      • => Promotion code is invalid.
    • createdByGuest
      • => API users can only place guest orders.
      • => This field is required.
    • user
      • => Customer is mandatory.
    • deliveryAddress
      • => Delivery address is out of zones.
      • => Invalid delivery address.
    • managementFees
      • => The management fees are invalid.
      • => This field is required.
    • shippingCost
      • => The shipping cost is invalid.
    • fees
      • => These fees are not applicable to this order.
      • => The fees provided are invalid.
    • total
      • => The total amount is invalid.
      • => The average delivery cost is lower than expected.
      • => This field is required.
    • items_total
      • => The items total is invalid.
    • discount_total
      • => The discount total is invalid.
    • franchise
      • => Unauthorized locale (%code%).
    • orderItems
      • => The total value of the order item is invalid.
      • => This field is required.
      • stepList
        • => Unauthorized locale (%code%).
        • => The format of the step item is invalid.
        • => The specified product could not be found.
        • => These fields (id, name, stepItem, stepTotalPrice) are required
        • stepItem
          • => These fields (id, products, price) are required
          • product
            • => These fields (id, sku, externalId, imageUrl, translations, calory, withAlcool, optionList, serveLater) are required
            • optionList
              • => These fields (id', 'type', 'optionVariant', 'translations', 'sideComponent', 'externalId', 'imageUrl', 'position) are required
      • optionList
        • => The option list contains invalid data.
        • => The maximum number of allowed option variants has been exceeded.
        • => The option is invalid.
        • => The option variants are invalid.
        • => These fields (id', 'type', 'optionVariant', 'translations', 'sideComponent', 'externalId', 'imageUrl', 'position) are required
      • product
        • => This field is required.
      • productShopMode
        • => This field is required.
      • quantity
        • => This field is required.
      • total
        • => This field is required.
      • note
        • => This field is required.
    • itemsTotal
      • => This field is required.
    • discountsTotal
      • => This field is required.
    • shopMode
      • => This field is required.
    • asap
      • => This field is required.
    • setting
      • => Order's setting attribute is invalid.
    • value
      • => Order's setting value attribute is invalid.
    • cutlery
      • => Order's setting cutlery attribute is invalid.
    • customerIdentifier
      • => Order's setting customer identifier attribute does not match with the configured one.
    • discounts
      • => Too many discounts.
    • loyalty
      • => Unauthorized.
      • => Loyalty attribute format is invalid.
      • customer
        • => Loyalty customer attribute is invalid.
        • => Too many rewards provided.
      • rewards
        • => Reward is invalid (id => %code%).
        • => The reward type is invalid.
        • => The reward data is invalid (id => %code%, attribut => %field%).
        • => The attribut Type/Value is invalid (id => %code%, value => %value%).
        • => The reward integrity is invalid.
        • => The reward discount is invalid (id => %code%).
        • => The rewards are missing.
  • 400
    => Invalid input
  • 400
    => Request failed
  • 404
    => Customer not found
  • 422
    => Unprocessable entity
  • 400
    => Invalid device's token
  • 401
    => Unrecognized device
/api/v2/orders/{id}
GET
  • 404
    => Resource not found
  • 400
    => Invalid device's token
  • 401
    => Unrecognized device
/api/v2/orders/{id}
PUT
  • 400
    => Invalid input
    • shop
      • => This field is required.
    • locale
      • => At least one locale is required.
      • => The selected locale (eg. es_ES) is invalid.
      • => Duplicated locale.
    • device
      • => Tokens shop's entity & shop's device do not match.
      • => This mode is not allowed on this device.
    • date
      • => This value should not be null.
      • => ASAP date is incorrect.
      • => Invalid order's date.
      • => Future date is invalid.
      • => Minimum number of days not met.
      • => Exceeds maximum number of days allowed.
      • => The order date minutes must be a multiple of the shop's order interval.
      • => The order date cannot be ASAP.
      • => Shop closed.
      • => Maximum orders for this slot has been reached. Please pick an other slot.
      • => Maximum products used in this slot has been reached. Please pick an other slot.
      • => Ordering hours are incorrect.
      • => Pickup hours are incorrect.
      • => This field is required.
    • tableNumber
      • => Table's number is missing.
    • customerName
      • => Customer's name is missing.
    • qoodosRewards
      • => Invalid free item data (id => %code%, sku => %sku%).
      • => Invalid Qoodos reward.
      • => Invalid Qoodos discount.
    • promotion
      • => Guests are not allowed.
      • => Minimum order amount not reached for promotion.
      • => Promotion code is invalid.
    • createdByGuest
      • => API users can only place guest orders.
      • => This field is required.
    • user
      • => Customer is mandatory.
    • deliveryAddress
      • => Delivery address is out of zones.
      • => Invalid delivery address.
    • managementFees
      • => The management fees are invalid.
      • => This field is required.
    • shippingCost
      • => The shipping cost is invalid.
    • fees
      • => These fees are not applicable to this order.
      • => The fees provided are invalid.
    • total
      • => The total amount is invalid.
      • => The average delivery cost is lower than expected.
      • => This field is required.
    • items_total
      • => The items total is invalid.
    • discount_total
      • => The discount total is invalid.
    • franchise
      • => Unauthorized locale (%code%).
    • orderItems
      • => The total value of the order item is invalid.
      • => This field is required.
      • stepList
        • => Unauthorized locale (%code%).
        • => The format of the step item is invalid.
        • => The specified product could not be found.
        • => These fields (id, name, stepItem, stepTotalPrice) are required
        • stepItem
          • => These fields (id, products, price) are required
          • product
            • => These fields (id, sku, externalId, imageUrl, translations, calory, withAlcool, optionList, serveLater) are required
            • optionList
              • => These fields (id', 'type', 'optionVariant', 'translations', 'sideComponent', 'externalId', 'imageUrl', 'position) are required
      • optionList
        • => The option list contains invalid data.
        • => The maximum number of allowed option variants has been exceeded.
        • => The option is invalid.
        • => The option variants are invalid.
        • => These fields (id', 'type', 'optionVariant', 'translations', 'sideComponent', 'externalId', 'imageUrl', 'position) are required
      • product
        • => This field is required.
      • productShopMode
        • => This field is required.
      • quantity
        • => This field is required.
      • total
        • => This field is required.
      • note
        • => This field is required.
    • itemsTotal
      • => This field is required.
    • discountsTotal
      • => This field is required.
    • shopMode
      • => This field is required.
    • asap
      • => This field is required.
    • setting
      • => Order's setting attribute is invalid.
    • value
      • => Order's setting value attribute is invalid.
    • cutlery
      • => Order's setting cutlery attribute is invalid.
    • customerIdentifier
      • => Order's setting customer identifier attribute does not match with the configured one.
    • discounts
      • => Too many discounts.
    • loyalty
      • => Unauthorized.
      • => Loyalty attribute format is invalid.
      • customer
        • => Loyalty customer attribute is invalid.
        • => Too many rewards provided.
      • rewards
        • => Reward is invalid (id => %code%).
        • => The reward type is invalid.
        • => The reward data is invalid (id => %code%, attribut => %field%).
        • => The attribut Type/Value is invalid (id => %code%, value => %value%).
        • => The reward integrity is invalid.
        • => The reward discount is invalid (id => %code%).
        • => The rewards are missing.
    • payment
      • => Order has some pending payments.
      • => This order cannot be modified.
  • 400
    => Invalid input
  • 404
    => Resource not found
  • 400
    => Request failed
  • 404
    => Customer not found
  • 422
    => Unprocessable entity
  • 400
    => Invalid device's token
  • 401
    => Unrecognized device
/api/v2/orders/{id}/accept
PATCH
  • 400
    => Invalid input
  • 403
    => Not allowed
  • 404
    => Resource not found
  • 422
    => Unprocessable entity
/api/v2/orders/{id}/cancel
PATCH
  • 400
    => Invalid input
  • 403
    => Not allowed
  • 404
    => Resource not found
  • 422
    => Unprocessable entity
  • 404
    => Customer not found
/api/v2/orders/{id}/delay
PATCH
  • 400
    => Invalid input
  • 403
    => Not allowed
  • 404
    => Resource not found
  • 422
    => Unprocessable entity
  • 404
    => Customer not found
  • 400
    => Missing or invalid parameters
/api/v2/orders/{id}/deliver
PATCH
  • 400
    => Invalid input
  • 403
    => Not allowed
  • 404
    => Resource not found
  • 422
    => Unprocessable entity
/api/v2/orders/{id}/pay
PATCH
  • 400
    => Invalid input
  • 403
    => Not allowed
  • 404
    => Resource not found
  • 422
    => Unprocessable entity
/api/v2/orders/{id}/ready
PATCH
  • 400
    => Invalid input
  • 403
    => Not allowed
  • 404
    => Resource not found
  • 422
    => Unprocessable entity
  • 404
    => Customer not found
/api/v2/orders/{id}/reject
PATCH
  • 400
    => Invalid input
  • 403
    => Not allowed
  • 404
    => Resource not found
  • 422
    => Unprocessable entity
  • 404
    => Customer not found
/api/v2/orders/cancel-payments
POST
  • 400
    => Invalid input
    • order
      • => The order payments cannot be cancelled
      • => Order not found
ORDERING HOURS
/api/v2/ordering_hours/time_slots
GET
  • 401
    => Invalid User
  • 400
    => Bad Request
  • 400
    => Invalid shop settings
  • 404
    => Shop not found
PAYMENT
/api/v2/payments/create
POST
  • 401
    => Access Denied
  • 400
    => Missing parameters
  • 404
    => Order not found
  • 400
    => Payment method not found
  • 404
    => Order can not be placed for anonymous customer
  • 400
    => Cashback disabled in this shop or customer not found
  • 400
    => Cashback disabled in this franchise
  • 400
    => Insufficient cashback balance
  • 404
    => Customer not found
  • 400
    => Request failed
  • 400
    => Cashback process error
  • 400
    => Currency not supported
  • 400
    => Order amount's null
  • 400
    => Stripe invalid configuration
  • 400
    => Payment creation failed
/api/v2/payments/result
POST
  • 401
    => Access Denied
  • 400
    => Missing parameters
  • 400
    => Invalid json
  • 404
    => Payment not found
/api/v2/payments/{external_id}/status
GET
  • 401
    => Access Denied
  • 400
    => Invalid parameter
  • 404
    => Resource not found
/api/v2/payments/{id}/payplug-apple-pay/complete
PATCH
  • 400
    => Invalid input
    • payment
      • => This field is required.
      • => This value should not be null.
      • => This value should be a valid array.
      • => The Apple Pay token schema is invalid.
      • => The payment ID is invalid.
      • => The external payment ID is invalid.
      • => The external payment ID does not match the provided ID.
  • 400
    => An error occured with Payplug Apple pay when completing payment
  • 404
    => Payment not found
PAYMENT METHOD
/api/v2/payment_methods
GET
  • 401
    => Access Denied
/api/v2/payment_methods/{id}
GET
  • 401
    => Access Denied
  • 404
    => Resource not found
/api/v2/payment_methods/{id}/attach-image
POST
  • 401
    => Access Denied
  • 400
    => Image file is required
  • 400
    => Invalid input
  • 404
    => Resource not found
  • 422
    => Unprocessable entity
PRODUCT
/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.
PROMOTION
/api/v2/promotions/check
POST
  • 400
    => Invalid input
    • code
      • => Promotion code already used
      • => This value should not be blank.
      • => This value should not be null.
      • => This value should be a valid string.
    • mode
      • => This value should not be blank.
      • => This value should not be null.
      • => Invalid mode.
    • promotion
      • => The promotion is invalid.
      • => The customer is invalid for this promotion.
      • => This promotion is disabled.
      • => This promotion has expired.
      • => This promotion has already been used.
      • => This promotion is valid only for your first order.
/api/v2/promotions/{id}
GET
  • 401
    => Invalid User
  • 404
    => Resource not found
/api/v2/promotions/{id}/attach-image
POST
  • 401
    => Access Denied
  • 400
    => Image file is required
  • 400
    => Invalid input
  • 404
    => Resource not found
  • 422
    => Unprocessable entity
PROMOTIONAL OFFER
/api/v2/promotional_offers/{id}
GET
  • 401
    => Invalid User
  • 404
    => Resource not found
/api/v2/promotional_offers/{id}/attach-image
POST
  • 401
    => Access Denied
  • 400
    => Image file is required
  • 400
    => Invalid input
  • 404
    => Resource not found
  • 422
    => Unprocessable entity
RESOURCES
/api/v2/*
*
  • 403
    => Forbidden
  • 400
    => The source is mandatory
  • 400
    => The api version is mandatory
  • 400
    => Invalid api version
  • 400
    => Invalid source
SHOP
/api/v2/shops/sync
GET
  • 403
    => Access Denied
  • 401
    => Unauthorized
/api/v2/shops/{id}
GET
  • 403
    => Access Denied
  • 404
    => RESOURCE_NOT_FOUND
/api/v2/shops/{id}/close
PATCH
  • 403
    => Access Denied
  • 404
    => Resource not found
  • 400
    => Bad Request
  • 404
    => Order close interval not found
/api/v2/shops/{id}/open
PATCH
  • 403
    => Access Denied
  • 404
    => Resource not found
/api/v2/shops/{id}/options
GET
  • 403
    => Access Denied
  • 404
    => Resource not found
/api/v2/shops/{id}/shop_modes
GET
  • 403
    => Access Denied
  • 404
    => Resource not found
/api/v2/shops/{id}/legal_terms
GET
  • 404
    => Resource not found
  • 400
    => Invalid Domain name
SHOP MANAGER
/api/v2/shop_managers
GET
  • 401
    => Invalid User
/api/v2/shop_managers/{id}
GET
  • 401
    => Invalid User
  • 404
    => Resource not found
SHOP MODE
/api/v2/shop_modes/{id}
GET
  • 403
    => Access Denied
  • 404
    => Resource not found
/api/v2/shop_modes/{id}/attach-image
POST
  • 401
    => Access Denied
  • 400
    => Image file is required
  • 400
    => Invalid input
  • 404
    => Resource not found
  • 422
    => Unprocessable entity
/api/v2/shops/{id}/shop_modes
GET
  • 403
    => Access Denied
  • 404
    => Resource not found
TAXE
/api/v2/taxes
GET
  • 401
    => Invalid User
USER OAUTH
/api/v2/phone/send-verification-code
POST
  • 400
    => Invalid input
    • phone
      • => Invalid format.
      • => The phone number must be a valid mobile number.
      • => This field is required.
  • 400
    => Phone already verified
  • 400
    => Code already sent
  • 400
    => Request failed
  • 429
    => Too Many Requests
  • 422
    => Unprocessable entity
/api/v2/phone/verify
POST
  • 400
    => Invalid input
    • phone
      • => Invalid format.
      • => The phone number must be a valid mobile number.
      • => The code number must contain 6 digits.
  • 400
    => Invalid phone or code
  • 422
    => Unprocessable entity
WEBHOOK
/api/v2/webhooks/{id}
PATCH
  • 401
    => Invalid User
  • 400
    => Webhook's id is required
  • 400
    => New url is required
  • 400
    => User's webhook not found
  • 400
    => Url already exists
  • 422
    => Unprocessable entity
Loading…
Loading the web debug toolbar…
Attempt #