Reference

This is a flat view of all the representations and relations. If you would rather explore our API starting from the Entry Point, please use the Browser.

Quick reminder:
  • Special characters @, /, \\, " and numbers 0 to 9 are strictly prohibited in the API for the various names fields (Given Name, Family Name, etc.)
  • Representation: a set of name-value pairs representing the state of a resource.
  • Relation: the identifier of a link between two resources.

errors

error-representation

Description: An error representation. This structure is mainly used to as the HTTP body associated to a response of a failed HTTP method invocation.

Properties
code
A code identifying an order error during Checkout. Constraints: Integer, Read-Only.
message
A human readable message describing the order error. Constraints: Text, Read-Only.