Contents x
    Retrieve a given customer by id
    • 15 Nov 2024
    • 2 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Contents

    Retrieve a given customer by id

    • Updated on 15 Nov 2024
    • 2 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Article summary

    Get
    /customers/{id}

    Retrieve a given customer by id

    Security
    HTTP
    Type bearer
    Path parameters
    id
    stringRequired

    The id of the customer to retrieve

    Responses
    200

    Customer with matching id

    Expand All
    object
    id
    string
    email
    string (email)
    firstName
    string
    lastName
    string
    addresses
    Array of object (Address)
    Min items1
    object
    id
    string
    line1
    string
    line2
    string
    city
    string
    province
    string
    zipcode
    string
    country
    string
    meta
    object (MetadataBlock)

    Block that allows for the arbitary passing of metadata alongside an entity

    property*

    Can be any value - string, number, boolean, array or object

    400

    Invalid request

    Expand All
    object

    Response body, based upon RFC-9457 specification, for 400 error codes

    title
    string
    status
    number
    Valid values[ "401" ]
    errors
    Array of object

    Array contain the reason(s) for why the request being invalid

    object
    title
    string

    Short human readable explaination for the violation

    detail
    string

    JSON string containing a human-readable explanation specific to this occurrence of the problem.

    Consumers should not parse this property to extract information, but instead should rely on extension properties.

    401

    Invalid authentication token

    object

    Response body, based upon RFC-9457 specification, for 401 error codes

    title
    string
    Valid values[ "No authorisation token provided", "Unauthorised token provided" ]
    status
    number
    Valid values[ "401" ]
    403

    Invalid authorization permissions

    object

    Response body, based upon RFC-9457 specification, for 403 error codes

    title
    string
    Valid values[ "Invalid permissions for request" ]
    status
    number
    Valid values[ "403" ]
    404

    Customer not found

    object

    Response body, based upon RFC-9457 specification, for 404 error codes

    title
    string
    Valid values[ "Entity not found" ]
    status
    number
    Valid values[ "404" ]
    500

    Internal server error

    object

    Error response body, as defined in RFC-9457. Please refer to the specification for more detail on each of the properties.

    Other properties can be provided, Extensions, to provide more detailed information for consumers, such as balance in a credit based error.

    type
    string (uri)

    URI reference that identifies the problem type, which consumer must use as the problem type's primrary identifier.

    Relative URI's can be used; however, fully qualified URI's are preferred to avoid confusion, as implementations may not handle relative URIs correctly.

    status
    number

    HTTP status code generated by the origin server.

    This value, if provided, should match the HTTP status code sent by the server. But this disagree on the consumer, due to intermediaries such as proxies and caches.

    title
    string

    Short, human-readable summary of the problem type

    detail
    string

    JSON string containing a human-readable explanation specific to this occurrence of the problem.

    Consumers should not parse this property to extract information, but instead should rely on extension properties.

    instance
    string (uri)

    JSON string containing a URI reference that identifies the specific occurrence of the problem.

    Was this article helpful?
    What's Next