Documentation Powered by Redocly

Receipt Layout API (1.0.0)

Download OpenAPI specification:Download

The API allows you to define the static information found in the header and footer of printed receipts, such as logotype, address, opening hours etc.

A layout consists of:

  • (Optional) Headers (text or image data) at the top of a receipt
  • (Optional) Footers (text or image data) at the bottom of the receipt

Inbetween headers and footers are line items. These are not part of a receipt layout entity.

The ordering of the layouts headers/footers will be reflected on the stores' receipts.

Each text- or image-section can be extended with custom properties.

Authentication

ocms

Machine authentication is supported with OCMS.

Security Scheme Type OAuth2
clientCredentials OAuth Flow
Token URL: https://auth.retailsvc.com/oauth2/token
Scopes:

    receipt

    Add receipt layout

    Add a receipt layout

    Authorizations:
    ocms
      header Parameters
      Correlation-Id
      string <uuid>
      Example: fe0aded2-ba52-11eb-a075-e3d570c587ed

      Id used for tracking a request throughout the system(s).
      If not supplied, it will be automatically generated by this system.

      Request Body schema: application/json
      businessUnitGroupId
      required
      string

      Identifier for the business unit group that this layout applies to.

      effectiveDate
      string <date>

      The date when this layout should be applied, if present. It is up to the integrator to make sure that a current layout exists in the final system, if a layout has a future effectiveDate set.
      The current date will be used if left out and layout will take effect immediately.

      Array of objects (ImagesType) [ items ]
      required
      Array of ImageSection (object) or TextSection (object) (Section) [ items ]

      A ReceiptLayout consists of Sections.

      Responses

      Request samples

      Content type
      application/json
      {
      • "businessUnitGroupId": "store-1",
      • "sections": [
        ]
      }