Documentation Powered by ReDoc

External contact management API (0.0.1)

Download OpenAPI specification:Download

Resolve contacts

Resolve a contact identifier to a contact

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
identifier_code
required
string [ 1 .. 256 ] characters

The identifier code to validate.

Usually scanned from a barcode or QR code or entered manually by the merchant/user.

purpose
required
string (ContactResolutionPurpose)
Enum: "RESOLVE_CUSTOMER_FOR_ORDER" "RESOLVE_COLLECTOR_FOR_PICKUP" "RESOLVE_RECIPIENT_FOR_DELIVERY"

The purpose for invoking a contact resolution. As in "what is the contact needd for".

context
required
object (APIUsageContext)

Information about the context for/in which the API is used.

Responses

200

The result of the request.

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

post /org/{org-id}/external-contact-management/contacts/resolve
/org/{org-id}/external-contact-management/contacts/resolve

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "identifier_code": "string",
  • "purpose": "RESOLVE_CUSTOMER_FOR_ORDER",
  • "context":
    {
    }
}

Response samples

Content type
application/json
Example
ResolveContactSuccess
Copy
 Expand all Collapse all
{
  • "@type": "ResolveContactSuccess",
  • "contact":
    {
    }
}

Status checks

Check what payment options are available for a customer

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
customer
required
any (ContactInformation)

Information about a contact.

Depending on the type of contact (private person, organization, organization with representative) and whether the entities are modeled as contacts via the contacts API, different structures are used.

Note that this structure is used to reference plain contacts as well as contacts with a specific role such as customer or suppliers. Depending on the usage context, not all types of contact informations may be usable.

context
required
object (APIUsageContext)

Information about the context for/in which the API is used.

Responses

200

The result of the request.

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

post /org/{org-id}/external-contact-management/customers/check-available-payment-options
/org/{org-id}/external-contact-management/customers/check-available-payment-options

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "customer":
    {
    },
  • "context":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "later":
    {
    },
  • "invoice":
    {
    },
  • "deferred_invoicing":
    {
    }
}