Documentation Powered by ReDoc

enfore Organization Structure & Configuration API (0.37.1)

Download OpenAPI specification:Download

enfore API for managing organization structure and configuration

POS Sales Channels

Iterate over POS sales channels.

Returns POS sales channels, sorted in ascending order by name.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

sales-type
Array of strings (SalesType)
Items Enum: "OTC" "PICKUP" "DELIVERY"

When specified, only PosSalesChannels with one of the specified types are returned.

service-location-id
string [ 1 .. 256 ] characters

When specified, only the PosSalesChannel with the specified service location will be returned (if one exists).

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/pos-sales-channels

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/pos-sales-channels

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Create a new POS sales channel

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

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

An identifier for the sales channel.

name
required
string <= 256 characters

The name of the sales channel

service_location_address
required
object (Address)

An address of a location/destination

assortment_tags
Array of objects (SalesChannelAssortmentTagConfiguration)

The assortment tags of the sales channel as well as configuration specific to each tag.

Those tags control what products are "listed on/at" the sales channel. A product is considered listed at/on a sales channel when the intersection of the product's and the locations's assortment tags is not empty.

Note:

  • For each specific tag, at most one entry must exist in the list.
  • For now, no tag-specific configuration exists. The wrapper has been defined now though as to be prepared to add configuration later without the needs to redefine the whole set.
use_new_business_day_model
boolean
Deprecated

Flag indicating whether the new POS sales channel's service location shall immediately be configured to use the new business day model or not.

Deprecated: Sales channels created for enforePOS1 never use the new business day model. For channels created for enforePOS2 the use of the new business day model is mandatory.

location_language
object (LocalizedString)

Holds a text that is optionally localized to different languages.

Responses

201

Created POS sales channel

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

422

Specified data is semantically incorrect.

post/org/{org-id}/pos-sales-channels

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/pos-sales-channels

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "sales_channel_id": "string",
  • "name": "string",
  • "service_location_address":
    {
    },
  • "assortment_tags":
    [
    ],
  • "use_new_business_day_model": true,
  • "location_language":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "sales_channel_id": "string",
  • "name": "string",
  • "service_location": "string",
  • "assortment_tags":
    [
    ],
  • "inventory_management_configuration_id": "string"
}

Get a list of subscriptions for POS Sales Channels

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Responses

200

List of registrations

403

Credentials missing or not sufficient

get/org/{org-id}/pos-sales-channel-subscriptions

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/pos-sales-channel-subscriptions

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Register an event consumer with the API.

If the callback URL is already registered, we return the original subscription ID. We will continue attempting to send new items to registered subscriptions until they are deleted. In case we cannot reach the endpoint, we will apply an exponential backoff.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
callback_url
required
string <uri>

The callback URL where event notifications are to be delivered. It must be HTTPS to prevent man-in-the-middle attacks.

Responses

201

Registration of subscription successful (or already subscribed)

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

Callbacks

post<no summary>
post/org/{org-id}/pos-sales-channel-subscriptions

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/pos-sales-channel-subscriptions

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Callback payload samples

Callback
POST: <no summary>
Content type
application/json
Copy
 Expand all Collapse all
{
  • "org_id": "string",
  • "items":
    [
    ],
  • "problems":
    []
}

Delete a subscription for POS sales channels

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

subscription-id
required
string

ID of the subscription to delete

Responses

204

Subscription was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/pos-sales-channel-subscriptions/{subscription-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/pos-sales-channel-subscriptions/{subscription-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Load a sales channel

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

sales-channel-id
required
string

ID of the sales channel to act upon

Responses

200

Sales channel is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/pos-sales-channels/{sales-channel-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/pos-sales-channels/{sales-channel-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "sales_channel_id": "string",
  • "name": "string",
  • "service_location": "string",
  • "assortment_tags":
    [
    ],
  • "inventory_management_configuration_id": "string"
}

Partial update for a POS sales channel

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

sales-channel-id
required
string

ID of the sales channel to act upon

Request Body schema: application/json
@type
required
string
Default: "POSSalesChannelAssortmentTagUpdate"
POSSalesChannelAssortmentTagUpdate
assortment_tags
Array of objects (SalesChannelAssortmentTagConfiguration)

The new assortment tags for the sales channel. When not specified or empty, all existing assortment tags are removed from the sales channel.

Note: * For each specific tag, at most one entry must exist in the list.

Responses

200

Sales channel was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

patch/org/{org-id}/pos-sales-channels/{sales-channel-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/pos-sales-channels/{sales-channel-id}

Request samples

Content type
application/json
Example
POSSalesChannelAssortmentTagUpdate
Copy
 Expand all Collapse all
{
  • "@type": "POSSalesChannelAssortmentTagUpdate",
  • "assortment_tags":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "sales_channel_id": "string",
  • "name": "string",
  • "service_location": "string",
  • "assortment_tags":
    [
    ],
  • "inventory_management_configuration_id": "string"
}

Load a sales channel incl. all subresources

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

sales-channel-id
required
string

ID of the sales channel to act upon

Responses

200

Sales channel and subresources successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/pos-sales-channels/{sales-channel-id}/full

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/pos-sales-channels/{sales-channel-id}/full

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "pos_sales_channel":
    {
    },
  • "sales_configuration":
    {
    },
  • "sales_order_configuration":
    {
    },
  • "pickup_configuration":
    {
    },
  • "delivery_configuration":
    {
    },
  • "invoicing_configuration":
    {
    }
}

Load a sales channel's sales configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

sales-channel-id
required
string

ID of the sales channel to act upon

Responses

200

Sales channel sales configuration is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/pos-sales-channels/{sales-channel-id}/sales-configuration

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/pos-sales-channels/{sales-channel-id}/sales-configuration

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "sales_types":
    [
    ]
}

Set a sales channel's sales configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

sales-channel-id
required
string

ID of the sales channel to act upon

Request Body schema: application/json
sales_types
required
Array of strings (SalesType)
Items Enum: "OTC" "PICKUP" "DELIVERY"

The sales types enabled for the channel.

Responses

200

Configuration was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

put/org/{org-id}/pos-sales-channels/{sales-channel-id}/sales-configuration

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/pos-sales-channels/{sales-channel-id}/sales-configuration

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "sales_types":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "sales_types":
    [
    ]
}

Load a sales channel's sales order configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

sales-channel-id
required
string

ID of the sales channel to act upon

Responses

200

Sales channel sales order configuration is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/pos-sales-channels/{sales-channel-id}/sales-order-configuration

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/pos-sales-channels/{sales-channel-id}/sales-order-configuration

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "require_customer_for_processing": false,
  • "allow_organization_contacts_without_representative": false
}

Set a sales channel's sales order configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

sales-channel-id
required
string

ID of the sales channel to act upon

Request Body schema: application/json
require_customer_for_processing
required
boolean
Default: false

When set to true, a customer must be defined for a sales order to be able to be processed. Otherwise, sales orders can be processed without having a customer.

allow_organization_contacts_without_representative
required
boolean
Default: false

When set to true, an organization contact could be used directly (without an representative) in sales register.

Responses

200

Configuration was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

put/org/{org-id}/pos-sales-channels/{sales-channel-id}/sales-order-configuration

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/pos-sales-channels/{sales-channel-id}/sales-order-configuration

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "require_customer_for_processing": false,
  • "allow_organization_contacts_without_representative": false
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "require_customer_for_processing": false,
  • "allow_organization_contacts_without_representative": false
}

Load a sales channel's pickup configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

sales-channel-id
required
string

ID of the sales channel to act upon

Responses

200

Sales channel pickup configuration is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/pos-sales-channels/{sales-channel-id}/pickup-configuration

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/pos-sales-channels/{sales-channel-id}/pickup-configuration

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "pickup_types":
    [
    ],
  • "additional_pickup_locations":
    [
    ],
  • "processing_configuration":
    {
    },
  • "document_configuration":
    {
    }
}

Set a sales channel's pickup configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

sales-channel-id
required
string

ID of the sales channel to act upon

Request Body schema: application/json
pickup_types
required
Array of strings (PickupType)
Items Enum: "AD_HOC" "SCHEDULED"

The types of pickup that are supported at channel's service location.

additional_pickup_locations
required
Array of objects (PickupLocationAndTypes)

Any additional locations for pickups and the pickup types available for each location.

processing_configuration
required
object (PickupProcessingConfiguration)

Set of options that configures the processing of pickups.

document_configuration
required
object (PickupDocumentConfiguration)

Configuration that controls what business documents are created during the pickup process.

  • order_confirmation - Whether and how order confirmations are to be distributed. Valid options are e-mail, SMS and printing.
  • pickup_slip - Whether and how pickup slips are to be distributed. Valid options are e-mail, SMS and printing.
  • pickup_notification - Whether and how pickup notifications are to be distributed. Valid options are e-mail, SMS and calling a pager.
  • packing_slip - Whether and how packing slips are to be distributed. Valid options are e-mail, SMS and printing.
  • invoice - Whether and how invoices are to be distributed. Valid options are e-mail, SMS and printing.

The distribution settings for order_confirmation and invoice always apply to the whole sales order, as long as it contains a single item that is to be picked up.

Additionally, for orders that have items for pickup as well as items for delivery, the distribution settings for order_confirmation and invoice are combined with the ones from the DeliveryDocumentConfiguration.

Responses

200

Configuration was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

put/org/{org-id}/pos-sales-channels/{sales-channel-id}/pickup-configuration

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/pos-sales-channels/{sales-channel-id}/pickup-configuration

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "pickup_types":
    [
    ],
  • "additional_pickup_locations":
    [
    ],
  • "processing_configuration":
    {
    },
  • "document_configuration":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "pickup_types":
    [
    ],
  • "additional_pickup_locations":
    [
    ],
  • "processing_configuration":
    {
    },
  • "document_configuration":
    {
    }
}

Load a sales channel's delivery configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

sales-channel-id
required
string

ID of the sales channel to act upon

Responses

200

Sales channel delivery configuration is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/pos-sales-channels/{sales-channel-id}/delivery-configuration

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/pos-sales-channels/{sales-channel-id}/delivery-configuration

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "processing_configuration":
    {
    },
  • "document_configuration":
    {
    }
}

Set a sales channel's delivery configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

sales-channel-id
required
string

ID of the sales channel to act upon

Request Body schema: application/json
processing_configuration
required
object (DeliveryProcessingConfiguration)

Set of options that configures the processing of deliveries.

document_configuration
required
object (DeliveryDocumentConfiguration)

Configuration that controls what business documents are created during the delivery process.

  • order_confirmation - Whether and how order confirmations are to be distributed. Valid options are e-mail, SMS and printing.
  • delivery_note - Whether and how delivery notes are to be distributed. Valid options are e-mail, SMS and printing.
  • shipping_notification - Whether and how shipping notifications are to be distributed. Valid options are e-mail, SMS and calling a pager.
  • invoice - Whether and how invoices are to be distributed. Valid options are e-mail, SMS and printing.

The distribution settings for order_confirmation and invoice always apply to the whole sales order, as long as it contains a single item that is to be delivery.

Additionally, for orders that have items for delivery as well as items for pickup, the distribution settings for order_confirmation and invoice are combined with the ones from the PickupDocumentConfiguration.

Responses

200

Configuration was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

put/org/{org-id}/pos-sales-channels/{sales-channel-id}/delivery-configuration

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/pos-sales-channels/{sales-channel-id}/delivery-configuration

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "processing_configuration":
    {
    },
  • "document_configuration":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "processing_configuration":
    {
    },
  • "document_configuration":
    {
    }
}

Load a sales channel's invoicing configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

sales-channel-id
required
string

ID of the sales channel to act upon

Responses

200

Sales channel invoicing configuration is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/pos-sales-channels/{sales-channel-id}/invoicing-configuration

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/pos-sales-channels/{sales-channel-id}/invoicing-configuration

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "issue_formal_invoices_only": true,
  • "default_invoice_amount_mode": "UNSPECIFIED"
}

Set a sales channel's invoicing configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

sales-channel-id
required
string

ID of the sales channel to act upon

Request Body schema: application/json
issue_formal_invoices_only
required
boolean
default_invoice_amount_mode
required
string (DefaultInvoiceAmountMode)
Enum: "UNSPECIFIED" "GROSS" "NET"

The mode controlling the default for what amounts are used for invoices.

Possible options are:

  • UNSPECIFIED - No default set
  • GROSS - Invoices use gross amounts by default
  • NET - Invoices use net amounts by default

Responses

200

Configuration was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

put/org/{org-id}/pos-sales-channels/{sales-channel-id}/invoicing-configuration

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/pos-sales-channels/{sales-channel-id}/invoicing-configuration

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "issue_formal_invoices_only": true,
  • "default_invoice_amount_mode": "UNSPECIFIED"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "issue_formal_invoices_only": true,
  • "default_invoice_amount_mode": "UNSPECIFIED"
}

Catalog Sales Channels

Iterate over catalog sales channels.

Returns catalog sales channels, sorted in ascending order by name.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/catalog-sales-channels

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/catalog-sales-channels

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Create a new catalog sales channel

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

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

An additional identifier for the sales channel that must be unique across the organization.

name
required
string <= 256 characters

The name of the sales channel.

visibility
required
string (CatalogSalesChannelVisibility)
Enum: "PUBLIC" "PRIVATE"

Possible visibility options for a catalog sales channel.

  • PUBLIC - The catalog can be seen by any organization.
  • PRIVATE - The catalog can only be seen by organizations that have explicitly been given access by the organization owning the channel.
published_subscription_topics
Array of strings (ResourceCatalogSubscriptionTopic)
Items Value: "FULL"
purchase_order_recipient_address
object (AddressReference)

An address given as either a reference to an address in some contact object (which contact is used depends on the context where the AddressReference is used) or as an Address structure. If both are provided, the Address structure is a snapshot of the referenced address from when the reference was created.

contact_information
object (CatalogSalesChannelContactInformation)
sales_item_navigations
object (CatalogSalesChannelSalesItemNavigations)

The IDs of the sales item navigations (see SalesItemNavigationConfiguration in the ERP-API) that shall be used for browsing the products of the catalog.

assortment_tags
Array of objects (SalesChannelAssortmentTagConfiguration)

The assortment tags of the sales channel as well as configuration specific to each tag.

Those tags control what products are "listed on/at" the sales channel. A product is considered listed at/on a sales channel when the intersection of the product's and the locations's assortment tags is not empty.

Note: * For each specific tag, at most one entry must exist in the list. * For now, no tag-specific configuration exists. The wrapper has been defined now though as to be prepared to add configuration later without the needs to redefine the whole set.

inventory_management_configuration_id
string [ 1 .. 256 ] characters

The ID of the InventoryManagementConfiguration used by the sales channel. When not set, the channel uses the organization's default inventory management config.

available_shipping_services
Array of any (ShippingServiceReference)
available_pickup_locations
Array of strings

The IDs of the service locations where pickup for orders via the channel can be picked up at.

available_payment_options
object (CatalogSalesChannelPaymentOptions)

Configuration of the payment options available to customers of the catalog.

Responses

201

Created catalog sales channel

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

422

Specified data is semantically incorrect.

post/org/{org-id}/catalog-sales-channels

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/catalog-sales-channels

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "sales_channel_id": "string",
  • "name": "string",
  • "visibility": "PUBLIC",
  • "published_subscription_topics":
    [
    ],
  • "purchase_order_recipient_address":
    {
    },
  • "contact_information":
    {
    },
  • "sales_item_navigations":
    {
    },
  • "assortment_tags":
    [
    ],
  • "inventory_management_configuration_id": "string",
  • "available_shipping_services":
    [
    ],
  • "available_pickup_locations":
    [
    ],
  • "available_payment_options":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "sales_channel_id": "string",
  • "name": "string",
  • "visibility": "PUBLIC",
  • "published_subscription_topics":
    [
    ],
  • "purchase_order_recipient_address":
    {
    },
  • "contact_information":
    {
    },
  • "sales_item_navigations":
    {
    },
  • "assortment_tags":
    [
    ],
  • "inventory_management_configuration_id": "string",
  • "available_shipping_services":
    [
    ],
  • "available_pickup_locations":
    [
    ],
  • "available_payment_options":
    {
    }
}

Load a catalog sales channel

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

sales-channel-id
required
string

ID of the sales channel to act upon

Responses

200

Catalog sales channel is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/catalog-sales-channels/{sales-channel-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/catalog-sales-channels/{sales-channel-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "sales_channel_id": "string",
  • "name": "string",
  • "visibility": "PUBLIC",
  • "published_subscription_topics":
    [
    ],
  • "purchase_order_recipient_address":
    {
    },
  • "contact_information":
    {
    },
  • "sales_item_navigations":
    {
    },
  • "assortment_tags":
    [
    ],
  • "inventory_management_configuration_id": "string",
  • "available_shipping_services":
    [
    ],
  • "available_pickup_locations":
    [
    ],
  • "available_payment_options":
    {
    }
}

Update a catalog sales channel

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

sales-channel-id
required
string

ID of the sales channel to act upon

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

An additional identifier for the sales channel that must be unique across the organization.

name
required
string <= 256 characters

The name of the sales channel.

visibility
required
string (CatalogSalesChannelVisibility)
Enum: "PUBLIC" "PRIVATE"

Possible visibility options for a catalog sales channel.

  • PUBLIC - The catalog can be seen by any organization.
  • PRIVATE - The catalog can only be seen by organizations that have explicitly been given access by the organization owning the channel.
published_subscription_topics
Array of strings (ResourceCatalogSubscriptionTopic)
Items Value: "FULL"
purchase_order_recipient_address
object (AddressReference)

An address given as either a reference to an address in some contact object (which contact is used depends on the context where the AddressReference is used) or as an Address structure. If both are provided, the Address structure is a snapshot of the referenced address from when the reference was created.

contact_information
object (CatalogSalesChannelContactInformation)
sales_item_navigations
object (CatalogSalesChannelSalesItemNavigations)

The IDs of the sales item navigations (see SalesItemNavigationConfiguration in the ERP-API) that shall be used for browsing the products of the catalog.

assortment_tags
Array of objects (SalesChannelAssortmentTagConfiguration)

The assortment tags of the sales channel as well as configuration specific to each tag.

Those tags control what products are "listed on/at" the sales channel. A product is considered listed at/on a sales channel when the intersection of the product's and the locations's assortment tags is not empty.

Note: * For each specific tag, at most one entry must exist in the list. * For now, no tag-specific configuration exists. The wrapper has been defined now though as to be prepared to add configuration later without the needs to redefine the whole set.

inventory_management_configuration_id
string [ 1 .. 256 ] characters

The ID of the InventoryManagementConfiguration used by the sales channel. When not set, the channel uses the organization's default inventory management config.

available_shipping_services
Array of any (ShippingServiceReference)
available_pickup_locations
Array of strings

The IDs of the service locations where pickup for orders via the channel can be picked up at.

available_payment_options
object (CatalogSalesChannelPaymentOptions)

Configuration of the payment options available to customers of the catalog.

Responses

200

Catalog sales channel is successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

put/org/{org-id}/catalog-sales-channels/{sales-channel-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/catalog-sales-channels/{sales-channel-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "sales_channel_id": "string",
  • "name": "string",
  • "visibility": "PUBLIC",
  • "published_subscription_topics":
    [
    ],
  • "purchase_order_recipient_address":
    {
    },
  • "contact_information":
    {
    },
  • "sales_item_navigations":
    {
    },
  • "assortment_tags":
    [
    ],
  • "inventory_management_configuration_id": "string",
  • "available_shipping_services":
    [
    ],
  • "available_pickup_locations":
    [
    ],
  • "available_payment_options":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "sales_channel_id": "string",
  • "name": "string",
  • "visibility": "PUBLIC",
  • "published_subscription_topics":
    [
    ],
  • "purchase_order_recipient_address":
    {
    },
  • "contact_information":
    {
    },
  • "sales_item_navigations":
    {
    },
  • "assortment_tags":
    [
    ],
  • "inventory_management_configuration_id": "string",
  • "available_shipping_services":
    [
    ],
  • "available_pickup_locations":
    [
    ],
  • "available_payment_options":
    {
    }
}

Partial update for a catalog sales channel

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

sales-channel-id
required
string

ID of the sales channel to act upon

Request Body schema: application/json
@type
required
string
Default: "CatalogSalesChannelAssortmentTagUpdate"
CatalogSalesChannelAssortmentTagUpdate
assortment_tags
Array of objects (SalesChannelAssortmentTagConfiguration)

The new assortment tags for the sales channel. When not specified or empty, all existing assortment tags are removed from the sales channel.

Note: * For each specific tag, at most one entry must exist in the list.

Responses

200

Sales channel was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

patch/org/{org-id}/catalog-sales-channels/{sales-channel-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/catalog-sales-channels/{sales-channel-id}

Request samples

Content type
application/json
Example
CatalogSalesChannelAssortmentTagUpdate
Copy
 Expand all Collapse all
{
  • "@type": "CatalogSalesChannelAssortmentTagUpdate",
  • "assortment_tags":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "sales_channel_id": "string",
  • "name": "string",
  • "visibility": "PUBLIC",
  • "published_subscription_topics":
    [
    ],
  • "purchase_order_recipient_address":
    {
    },
  • "contact_information":
    {
    },
  • "sales_item_navigations":
    {
    },
  • "assortment_tags":
    [
    ],
  • "inventory_management_configuration_id": "string",
  • "available_shipping_services":
    [
    ],
  • "available_pickup_locations":
    [
    ],
  • "available_payment_options":
    {
    }
}

OPR Sales Channels

Iterate over OPR sales channels.

Returns OPR sales channels, sorted in ascending order by name.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/opr-sales-channels

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/opr-sales-channels

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Load an OPR sales channel

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

sales-channel-id
required
string

ID of the sales channel to act upon

Responses

200

Sales channel is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/opr-sales-channels/{sales-channel-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/opr-sales-channels/{sales-channel-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "sales_channel_id": "string",
  • "name": "string",
  • "subdomain": "string",
  • "assortment_tags":
    [
    ],
  • "inventory_management_configuration_id": "string"
}

Partial update for an OPR sales channel

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

sales-channel-id
required
string

ID of the sales channel to act upon

Request Body schema: application/json
@type
required
string
Default: "OPRSalesChannelAssortmentTagUpdate"
OPRSalesChannelAssortmentTagUpdate
assortment_tags
Array of objects (SalesChannelAssortmentTagConfiguration)

The new assortment tags for the sales channel. When not specified or empty, all existing assortment tags are removed from the sales channel.

Note: * For each specific tag, at most one entry must exist in the list.

Responses

200

Sales channel was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

patch/org/{org-id}/opr-sales-channels/{sales-channel-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/opr-sales-channels/{sales-channel-id}

Request samples

Content type
application/json
Example
OPRSalesChannelAssortmentTagUpdate
Copy
 Expand all Collapse all
{
  • "@type": "OPRSalesChannelAssortmentTagUpdate",
  • "assortment_tags":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "sales_channel_id": "string",
  • "name": "string",
  • "subdomain": "string",
  • "assortment_tags":
    [
    ],
  • "inventory_management_configuration_id": "string"
}

Catalog Purchase Channels

Iterate over catalog purchase channels

Returns catalog purchase channels, sorted in ascending order by id.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/catalog-purchase-channels

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/catalog-purchase-channels

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Add a new catalog purchase channel

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
name
required
string
purchase_channel_id
string

Freely configurable (as long as unique) by the organization, this is most commonly used to store an external idenitifier for the channel to allow easy mapping between the external system and the enfore platform.

supplier
required
any (ContactRef)
catalog_sales_channel
required
object (CatalogSalesChannelRef)

A reference to a CatalogSalesChannel.

As the reference is used in context of a CatalogPurchaseChannel, it must consist of two ids. The id of the organization whose CatalogSalesChannel is referenced and the id of the CatalogSalesChannel itself.

usages
required
Array of strings (PurchaseChannelUsage)
Items Enum: "PURCHASING" "RESALE"
payment_configuration
object (PurchaseChannelPaymentConfig)

A purchase channel's payment configuration holds information about the preferred payment option this organization wants to use when purchasing via the channel.

fulfillment_configuration
any (PurchaseChannelFulfillmentConfig)
default_resell_sales_price_configuration
object (PurchaseChannelDefaultResellSalesPriceConfig)

A purchase channel's "default resell sales price" configuration controls how the default sales price for products purchased via the channel and resold to customers is determined.

There are two modes: * manual - The sales price must be manually entered by the user and is shown as "price upon agreement" until then * adjustment based - The sales price is determined from the suggested retail price or, when none is present, from the purchase price via an absolute or percentage-based adjustment.

Note that the "adjustment based" mode falls back to "manual" when not valid price/adjustment pair can be found. For example, when the configuration only has an adjustment to the suggested retail price but the product in question does not have one.

Note also that while both adjustments can be negative, only the adjustment to the suggested retail price usually is. Negative adjustments to purchase price are unusual and may even be illegal in certain jurisdictions/cases.

subscription_template
object (CatalogPurchaseChannelSubscriptionTemplate)

Responses

201

CPC has successfully been added

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

409

Resource(s) could not be processed because of a conflict in the current state of the resource

422

Specified data is semantically incorrect.

post/org/{org-id}/catalog-purchase-channels

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/catalog-purchase-channels

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "purchase_channel_id": "string",
  • "supplier":
    {
    },
  • "catalog_sales_channel":
    {
    },
  • "usages":
    [
    ],
  • "payment_configuration":
    {
    },
  • "fulfillment_configuration":
    {
    },
  • "default_resell_sales_price_configuration":
    {
    },
  • "subscription_template":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "purchase_channel_id": "string",
  • "supplier":
    {
    },
  • "catalog_sales_channel":
    {
    },
  • "usages":
    [
    ],
  • "payment_configuration":
    {
    },
  • "fulfillment_configuration":
    {
    },
  • "default_resell_sales_price_configuration":
    {
    },
  • "subscription_template":
    {
    }
}

Load a catalog purchase channel

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

cpc-id
required
string

ID of the catalog purchase channel to act upon

Responses

200

CPC is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/catalog-purchase-channels/{cpc-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/catalog-purchase-channels/{cpc-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "purchase_channel_id": "string",
  • "supplier":
    {
    },
  • "catalog_sales_channel":
    {
    },
  • "usages":
    [
    ],
  • "payment_configuration":
    {
    },
  • "fulfillment_configuration":
    {
    },
  • "default_resell_sales_price_configuration":
    {
    },
  • "subscription_template":
    {
    }
}

Update a catalog purchase channel

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

cpc-id
required
string

ID of the catalog purchase channel to act upon

Request Body schema: application/json
purchase_channel_id
string
usages
Array of strings (PurchaseChannelUsage)
Items Enum: "PURCHASING" "RESALE"
payment_configuration
object (PurchaseChannelPaymentConfig)

A purchase channel's payment configuration holds information about the preferred payment option this organization wants to use when purchasing via the channel.

fulfillment_configuration
any (PurchaseChannelFulfillmentConfig)
default_resell_sales_price_configuration
object (PurchaseChannelDefaultResellSalesPriceConfig)

A purchase channel's "default resell sales price" configuration controls how the default sales price for products purchased via the channel and resold to customers is determined.

There are two modes: * manual - The sales price must be manually entered by the user and is shown as "price upon agreement" until then * adjustment based - The sales price is determined from the suggested retail price or, when none is present, from the purchase price via an absolute or percentage-based adjustment.

Note that the "adjustment based" mode falls back to "manual" when not valid price/adjustment pair can be found. For example, when the configuration only has an adjustment to the suggested retail price but the product in question does not have one.

Note also that while both adjustments can be negative, only the adjustment to the suggested retail price usually is. Negative adjustments to purchase price are unusual and may even be illegal in certain jurisdictions/cases.

subscription_template
object (CatalogPurchaseChannelSubscriptionTemplate)

Responses

200

CPC was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

post/org/{org-id}/catalog-purchase-channels/{cpc-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/catalog-purchase-channels/{cpc-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "purchase_channel_id": "string",
  • "usages":
    [
    ],
  • "payment_configuration":
    {
    },
  • "fulfillment_configuration":
    {
    },
  • "default_resell_sales_price_configuration":
    {
    },
  • "subscription_template":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "purchase_channel_id": "string",
  • "supplier":
    {
    },
  • "catalog_sales_channel":
    {
    },
  • "usages":
    [
    ],
  • "payment_configuration":
    {
    },
  • "fulfillment_configuration":
    {
    },
  • "default_resell_sales_price_configuration":
    {
    },
  • "subscription_template":
    {
    }
}

Catalog Purchase Channels: Bulk product subscriptions

Create a new "Catalog purchase channel - bulk product subscription" operation

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

cpc-id
required
string

ID of the catalog purchase channel to act upon

Request Body schema: application/json
s3_upload_url
string

The upload URL generated by the enfore platform where the client must upload the JSON containing the BulkProductSubscriptionOperations structure to.

Responses

201

Bulk operation successfully created

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

post/org/{org-id}/catalog-purchase-channels/{cpc-id}/bulk-product-subscription

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/catalog-purchase-channels/{cpc-id}/bulk-product-subscription

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "s3_upload_url": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "s3_upload_url": "string"
}

Retrieve a "Catalog purchase channel - bulk product subscription" operation

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

cpc-id
required
string

ID of the catalog purchase channel to act upon

bulk-operation-id
required
string

ID of the bulk operation to act upon

Responses

200

The operation that was requested

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/catalog-purchase-channels/{cpc-id}/bulk-product-subscription/{bulk-operation-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/catalog-purchase-channels/{cpc-id}/bulk-product-subscription/{bulk-operation-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "s3_upload_url": "string"
}

Delete a "Catalog purchase channel - bulk product subscription" operation

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

cpc-id
required
string

ID of the catalog purchase channel to act upon

bulk-operation-id
required
string

ID of the bulk operation to act upon

Responses

204

Operation successfully removed.

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

delete/org/{org-id}/catalog-purchase-channels/{cpc-id}/bulk-product-subscription/{bulk-operation-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/catalog-purchase-channels/{cpc-id}/bulk-product-subscription/{bulk-operation-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Retrieve the status of a "Catalog purchase channel - bulk product subscription" operation

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

cpc-id
required
string

ID of the catalog purchase channel to act upon

bulk-operation-id
required
string

ID of the bulk operation to act upon

Responses

200

The status that was requested

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/catalog-purchase-channels/{cpc-id}/bulk-product-subscription/{bulk-operation-id}/status

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/catalog-purchase-channels/{cpc-id}/bulk-product-subscription/{bulk-operation-id}/status

Response samples

Content type
application/json
Copy
 Expand all Collapse all
"DRAFT"

Update the status of a "Catalog purchase channel - bulk product subscription" operation

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

cpc-id
required
string

ID of the catalog purchase channel to act upon

bulk-operation-id
required
string

ID of the bulk operation to act upon

Request Body schema: application/json
string (BulkOperationStatus)
Enum: "DRAFT" "IN_PROCESSING" "COMPLETED_FULL_SUCCESS" "COMPLETED_PARTIAL_SUCCESS" "COMPLETED_FAILED"

The possible states of a bulk operation:

  • DRAFT - The operation has not been started yet. Operation payload/data can still be uploaded and the operation can still be deleted/canceled.
  • IN_PROCESSING - The operation is being performed. Operation payload/data is fixed and the operation cannot be deleted/canceled anymore.
  • COMPLETED_FULL_SUCCESS - The operation is finished and no errors occurred.
  • COMPLETED_PARTIAL_SUCCESS - The operation is finished and resulted in a mix of successful changes and failures/errors.
  • COMPLETED_FAILED - The operation is finished and resulted in only failures/errors.

Responses

201

Status successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

put/org/{org-id}/catalog-purchase-channels/{cpc-id}/bulk-product-subscription/{bulk-operation-id}/status

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/catalog-purchase-channels/{cpc-id}/bulk-product-subscription/{bulk-operation-id}/status

Request samples

Content type
application/json
Copy
 Expand all Collapse all
"DRAFT"

Response samples

Content type
application/json
Copy
 Expand all Collapse all
"DRAFT"

Load the list of all failures of the "Catalog purchase channel - bulk product subscription" operation

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

cpc-id
required
string

ID of the catalog purchase channel to act upon

bulk-operation-id
required
string

ID of the bulk operation to act upon

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

Responses

200

List of failures is successfully returned

403

Credentials missing or not sufficient

422

Specified data is semantically incorrect.

get/org/{org-id}/catalog-purchase-channels/{cpc-id}/bulk-product-subscription/{bulk-operation-id}/failures

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/catalog-purchase-channels/{cpc-id}/bulk-product-subscription/{bulk-operation-id}/failures

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "failures":
    [
    ]
}

Service Locations

Iterate over service locations.

Returns service locations, sorted in ascending order by name.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/service-locations

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/service-locations

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Get a list of subscriptions for Service Locations

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Responses

200

List of registrations

403

Credentials missing or not sufficient

get/org/{org-id}/service-location-subscriptions

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/service-location-subscriptions

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Register an event consumer with the API.

If the callback URL is already registered, we return the original subscription ID. We will continue attempting to send new items to registered subscriptions until they are deleted. In case we cannot reach the endpoint, we will apply an exponential backoff.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
callback_url
required
string <uri>

The callback URL where event notifications are to be delivered. It must be HTTPS to prevent man-in-the-middle attacks.

Responses

201

Registration of subscription successful (or already subscribed)

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

Callbacks

post<no summary>
post/org/{org-id}/service-location-subscriptions

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/service-location-subscriptions

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Callback payload samples

Callback
POST: <no summary>
Content type
application/json
Copy
 Expand all Collapse all
{
  • "org_id": "string",
  • "items":
    [
    ],
  • "problems":
    []
}

Delete a subscription for service locations

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

subscription-id
required
string

ID of the subscription to delete

Responses

204

Subscription was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/service-location-subscriptions/{subscription-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/service-location-subscriptions/{subscription-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Load a service location

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

service-location-id
required
string

ID of the service location to act upon

Responses

200

Service location is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/service-locations/{service-location-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/service-locations/{service-location-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "service_location_id": "string",
  • "name": "string",
  • "address":
    {
    },
  • "location_language": "string",
  • "functions":
    [
    ],
  • "processing_locations":
    {
    },
  • "customer_document_information":
    {
    },
  • "shipping_services":
    [
    ],
  • "accounting_configuration":
    {
    },
  • "inventory_management_configurations":
    {
    },
  • "local_document_creation_service_access_configuration":
    {
    },
  • "uses_new_business_day_model": true
}

Partial update for a service location

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

service-location-id
required
string

ID of the service location to act upon

Request Body schema: application/json
@type
required
string
Default: "ServiceLocationLanguageUpdate"
ServiceLocationLanguageUpdate
location_language
string <bcp47>

Responses

200

Service location was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

patch/org/{org-id}/service-locations/{service-location-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/service-locations/{service-location-id}

Request samples

Content type
application/json
Example
ServiceLocationLanguageUpdate
Copy
 Expand all Collapse all
{
  • "@type": "ServiceLocationLanguageUpdate",
  • "location_language": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "service_location_id": "string",
  • "name": "string",
  • "address":
    {
    },
  • "location_language": "string",
  • "functions":
    [
    ],
  • "processing_locations":
    {
    },
  • "customer_document_information":
    {
    },
  • "shipping_services":
    [
    ],
  • "accounting_configuration":
    {
    },
  • "inventory_management_configurations":
    {
    },
  • "local_document_creation_service_access_configuration":
    {
    },
  • "uses_new_business_day_model": true
}

Set a service location's accounting configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

service-location-id
required
string

ID of the service location to act upon

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

Responses

200

Configuration was successfully updated

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

put/org/{org-id}/service-locations/{service-location-id}/accounting-configuration

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/service-locations/{service-location-id}/accounting-configuration

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "configuration_id": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "configuration_id": "string"
}

Set a service location's inventory management configurations

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

service-location-id
required
string

ID of the service location to act upon

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

The ID of the ManualStockModificationConfiguration used by the service location. When not set, the location uses the organization's default manual stocl modification config.

Responses

200

Configurations are successfully updated

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

put/org/{org-id}/service-locations/{service-location-id}/inventory-management-configurations

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/service-locations/{service-location-id}/inventory-management-configurations

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "manual_stock_modification_configuration_id": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "manual_stock_modification_configuration_id": "string"
}

Set a service location's local DCS access configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

service-location-id
required
string

ID of the service location to act upon

Request Body schema: application/json
url
required
string

The url of the external API implementation to be called.

credentials_key
required
string

The key that is used to access the credentials for calling the external API in the secure credentials storage.

timeout_in_millis
integer
Default: 2000

Time in milliseconds after which to timeout a call to the external API.

max_retries
integer
Default: 3

Number of times the external API call is retried if it timed out.

retry_interval_in_millis
integer
Default: 250

Time in milliseconds to wait before each retry.

Responses

200

Configuration was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

put/org/{org-id}/service-locations/{service-location-id}/local-document-creation-service-access-configuration

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/service-locations/{service-location-id}/local-document-creation-service-access-configuration

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "url": "string",
  • "credentials_key": "string",
  • "timeout_in_millis": 2000,
  • "max_retries": 3,
  • "retry_interval_in_millis": 250
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "url": "string",
  • "credentials_key": "string",
  • "timeout_in_millis": 2000,
  • "max_retries": 3,
  • "retry_interval_in_millis": 250
}

Remove a service location's local DCS access configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

service-location-id
required
string

ID of the service location to act upon

Responses

204

Configuration was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/service-locations/{service-location-id}/local-document-creation-service-access-configuration

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/service-locations/{service-location-id}/local-document-creation-service-access-configuration

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Set a service location's shipping services

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

service-location-id
required
string

ID of the service location to act upon

Request Body schema: application/json
items
required
Array of objects (ShippingServiceRef)

The shipping services which are available for local / urban shipping from this service location.

Responses

200

ShippingServiceRefs was successfully updated

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

put/org/{org-id}/service-locations/{service-location-id}/shipping-services

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/service-locations/{service-location-id}/shipping-services

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ]
}

Get service areas of a service location.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

service-location-id
required
string

ID of the service location to act upon

Responses

200

Data successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/service-locations/{service-location-id}/service-areas

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/service-locations/{service-location-id}/service-areas

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Load a service area

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

service-location-id
required
string

ID of the service location to act upon

service-area-id
required
string

ID of the service area to act upon

Responses

200

Service area is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/service-locations/{service-location-id}/service-areas/{service-area-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/service-locations/{service-location-id}/service-areas/{service-area-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "processing_locations":
    [
    ]
}

Get the regular business hours of a service location.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

service-location-id
required
string

ID of the service location to act upon

Responses

200

Data successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/service-locations/{service-location-id}/business-hours

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/service-locations/{service-location-id}/business-hours

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "regular":
    {
    },
  • "special":
    [
    ],
  • "closed":
    [
    ]
}

Processing Locations

Iterate over processing locations.

Returns processing locations, sorted in ascending order by name.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

service_location_id
string

When specified, only processing locations for the specified service location are returned.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/processing-locations

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/processing-locations

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Get a list of subscriptions for Processing Locations

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Responses

200

List of registrations

403

Credentials missing or not sufficient

get/org/{org-id}/processing-location-subscriptions

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/processing-location-subscriptions

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Register an event consumer with the API.

If the callback URL is already registered, we return the original subscription ID. We will continue attempting to send new items to registered subscriptions until they are deleted. In case we cannot reach the endpoint, we will apply an exponential backoff.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
callback_url
required
string <uri>

The callback URL where event notifications are to be delivered. It must be HTTPS to prevent man-in-the-middle attacks.

Responses

201

Registration of subscription successful (or already subscribed)

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

Callbacks

post<no summary>
post/org/{org-id}/processing-location-subscriptions

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/processing-location-subscriptions

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Callback payload samples

Callback
POST: <no summary>
Content type
application/json
Copy
 Expand all Collapse all
{
  • "org_id": "string",
  • "items":
    [
    ],
  • "problems":
    []
}

Delete a subscription for processing locations

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

subscription-id
required
string

ID of the subscription to delete

Responses

204

Subscription was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/processing-location-subscriptions/{subscription-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/processing-location-subscriptions/{subscription-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Load a processing location

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

processing-location-id
required
string

ID of the processing location to act upon

Responses

200

Processing location is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/processing-locations/{processing-location-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/processing-locations/{processing-location-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "service_location_id": "string",
  • "storage_locations":
    [
    ],
  • "configurations":
    {
    }
}

Partial update for a processing location

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

processing-location-id
required
string

ID of the processing location to act upon

Request Body schema: application/json
@type
required
string
Default: "ProcessingLocationConfigurationsUpdate"
ProcessingLocationConfigurationsUpdate
configurations
required
object (ProcessingLocationConfigurations)

Holds configurations for a processing location.

Responses

200

Processing location was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

patch/org/{org-id}/processing-locations/{processing-location-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/processing-locations/{processing-location-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "@type": "ProcessingLocationConfigurationsUpdate",
  • "configurations":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "service_location_id": "string",
  • "storage_locations":
    [
    ],
  • "configurations":
    {
    }
}

Storage Locations

Iterate over storage locations.

Returns storage locations, sorted in ascending order by name.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

service_location_id
string

When specified, only storage locations for the specified service location are returned.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/storage-locations

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/storage-locations

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Get a list of subscriptions for Storage Locations

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Responses

200

List of registrations

403

Credentials missing or not sufficient

get/org/{org-id}/storage-location-subscriptions

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/storage-location-subscriptions

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Register an event consumer with the API.

If the callback URL is already registered, we return the original subscription ID. We will continue attempting to send new items to registered subscriptions until they are deleted. In case we cannot reach the endpoint, we will apply an exponential backoff.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
callback_url
required
string <uri>

The callback URL where event notifications are to be delivered. It must be HTTPS to prevent man-in-the-middle attacks.

Responses

201

Registration of subscription successful (or already subscribed)

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

Callbacks

post<no summary>
post/org/{org-id}/storage-location-subscriptions

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/storage-location-subscriptions

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Callback payload samples

Callback
POST: <no summary>
Content type
application/json
Copy
 Expand all Collapse all
{
  • "org_id": "string",
  • "items":
    [
    ],
  • "problems":
    []
}

Delete a subscription for storage locations

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

subscription-id
required
string

ID of the subscription to delete

Responses

204

Subscription was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/storage-location-subscriptions/{subscription-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/storage-location-subscriptions/{subscription-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Load a storage location

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

storage-location-id
required
string

ID of the storage location to act upon

Responses

200

Storage location is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/storage-locations/{storage-location-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/storage-locations/{storage-location-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "service_location_id": "string",
  • "responsible_staff": "string",
  • "storage_tags":
    [
    ]
}

Partial update for a storage location

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

storage-location-id
required
string

ID of the storage location to act upon

Request Body schema: application/json
@type
required
string
Default: "StorageLocationStorageTagsUpdate"
StorageLocationStorageTagsUpdate
storage_tags
Array of objects (StorageLocationStorageTagConfiguration)

The new set of storage tags for the location.

When omitted or empty, the location's storage tags will be cleared.

Note: * For each specific tag, at most one entry must exist in the list. * For now, no tag-specific configuration exists. The wrapper has been defined now though as to be prepared to add configuration later without the needs to redefine the whole set.

Responses

200

Storage location was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

patch/org/{org-id}/storage-locations/{storage-location-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/storage-locations/{storage-location-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "@type": "StorageLocationStorageTagsUpdate",
  • "storage_tags":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "service_location_id": "string",
  • "responsible_staff": "string",
  • "storage_tags":
    [
    ]
}

Devices

Iterate over devices.

Returns devices, sorted in ascending order by name.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

service_location_id
string

When specified, only devices for the specified service location are returned.

function
string

When specified, only devices with the specified function are returned.

See DeviceFunction for allowed values

type
string

When specified, only devices with the specified type are returned.

See DeviceType for allowed values

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/devices

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/devices

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Get a list of subscriptions for Devices

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Responses

200

List of registrations

403

Credentials missing or not sufficient

get/org/{org-id}/device-subscriptions

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/device-subscriptions

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Register an event consumer with the API.

If the callback URL is already registered, we return the original subscription ID. We will continue attempting to send new items to registered subscriptions until they are deleted. In case we cannot reach the endpoint, we will apply an exponential backoff.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
callback_url
required
string <uri>

The callback URL where event notifications are to be delivered. It must be HTTPS to prevent man-in-the-middle attacks.

Responses

201

Registration of subscription successful (or already subscribed)

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

Callbacks

post<no summary>
post/org/{org-id}/device-subscriptions

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/device-subscriptions

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Callback payload samples

Callback
POST: <no summary>
Content type
application/json
Copy
 Expand all Collapse all
{
  • "org_id": "string",
  • "items":
    [
    ],
  • "problems":
    []
}

Delete a subscription for devices

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

subscription-id
required
string

ID of the subscription to delete

Responses

204

Subscription was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/device-subscriptions/{subscription-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/device-subscriptions/{subscription-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Load a device

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

device-id
required
string

ID of the device to act upon

Responses

200

Device is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/devices/{device-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/devices/{device-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "type": "ANDROID_PHONE",
  • "identifiers":
    {
    },
  • "functions":
    [
    ],
  • "location":
    {
    },
  • "is_active": true,
  • "vendor_name": "string",
  • "product_name": "string"
}

Load a device including its subresources

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

device-id
required
string

ID of the device to act upon

Responses

200

Device with subresources is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/devices/{device-id}/full

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/devices/{device-id}/full

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "device":
    {
    },
  • "printing_services":
    [
    ],
  • "barcode_scanning_services":
    [
    ],
  • "weighing_services":
    [
    ],
  • "payment_processing_services":
    [
    ],
  • "cash_handling_services":
    [
    ],
  • "fiscal_memory_services":
    [
    ],
  • "customer_facing_ui_services":
    [
    ]
}

Iterate over the printing services of a device.

Returns the printing services provided by the device.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

device-id
required
string

ID of the device to act upon

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/devices/{device-id}/printing-services

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/devices/{device-id}/printing-services

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Iterate over the barcode scanning services of a device.

Returns the barcode scanning services provided by the device.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

device-id
required
string

ID of the device to act upon

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/devices/{device-id}/barcode-scanning-services

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/devices/{device-id}/barcode-scanning-services

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Iterate over the weighing services of a device.

Returns the weighing services provided by the device.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

device-id
required
string

ID of the device to act upon

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/devices/{device-id}/weighing-services

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/devices/{device-id}/weighing-services

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Iterate over the payment processing services of a device.

Returns the payment processing services provided by the device.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

device-id
required
string

ID of the device to act upon

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/devices/{device-id}/payment-processing-services

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/devices/{device-id}/payment-processing-services

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Iterate over the cash handling services of a device.

Returns the cash handling services provided by the device.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

device-id
required
string

ID of the device to act upon

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/devices/{device-id}/cash-handling-services

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/devices/{device-id}/cash-handling-services

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Iterate over the fiscal memory services of a device.

Returns the fiscal memory services provided by the device.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

device-id
required
string

ID of the device to act upon

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/devices/{device-id}/fiscal-memory-services

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/devices/{device-id}/fiscal-memory-services

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Iterate over the customer facing UI services of a device.

Returns the customer facing UI services provided by the device.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

device-id
required
string

ID of the device to act upon

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/devices/{device-id}/customer-facing-ui-services

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/devices/{device-id}/customer-facing-ui-services

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Create a new customer facing UI service on a device

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

device-id
required
string

ID of the device to act upon

Request Body schema: application/json
usage_mode
required
string (CustomerFacingUIUsageMode)
Enum: "EXCLUSIVE" "INTERCHANGING" "DISABLED"

  • EXCLUSIVE
    The device is only to be used by customers.

    It will display some kind of idle/advertisement screen and not provide access to merchant-level UI flows (at least not without some special "unlock" action and password entry)

  • INTERCHANGING
    The device can be used by both merchants and customers interchangeably.

    This is only allowed for enforeDonner devices and shall use the same UI pattern as used for card payment via merchant-controlled enforeDonner.

  • DISABLED
    The device must not be used for customer interaction.

    This mode allows to temporarily block a device from being used for interaction with a customer but keep all settings in the associated service.

purposes
Array of strings (CustomerFacingUIPurpose)
Items Enum: "PRODUCT_PRESENTATION" "CUSTOMER_FACING_CUWOS" "SELF_SERVICE" "PAYMENTS"

The purposes for which this device shall be used (related to customer-facing UI).

Responses

200

Service successfully created

post/org/{org-id}/devices/{device-id}/customer-facing-ui-services

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/devices/{device-id}/customer-facing-ui-services

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "usage_mode": "EXCLUSIVE",
  • "purposes":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "usage_mode": "EXCLUSIVE",
  • "purposes":
    [
    ]
}

Load a customer facing UI service

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

device-id
required
string

ID of the device to act upon

service-id
required
string

ID of the service to act upon

Responses

200

Service is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/devices/{device-id}/customer-facing-ui-services/{service-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/devices/{device-id}/customer-facing-ui-services/{service-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "usage_mode": "EXCLUSIVE",
  • "purposes":
    [
    ]
}

Update a customer facing UI service

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

device-id
required
string

ID of the device to act upon

service-id
required
string

ID of the service to act upon

Request Body schema: application/json
usage_mode
required
string (CustomerFacingUIUsageMode)
Enum: "EXCLUSIVE" "INTERCHANGING" "DISABLED"

  • EXCLUSIVE
    The device is only to be used by customers.

    It will display some kind of idle/advertisement screen and not provide access to merchant-level UI flows (at least not without some special "unlock" action and password entry)

  • INTERCHANGING
    The device can be used by both merchants and customers interchangeably.

    This is only allowed for enforeDonner devices and shall use the same UI pattern as used for card payment via merchant-controlled enforeDonner.

  • DISABLED
    The device must not be used for customer interaction.

    This mode allows to temporarily block a device from being used for interaction with a customer but keep all settings in the associated service.

purposes
Array of strings (CustomerFacingUIPurpose)
Items Enum: "PRODUCT_PRESENTATION" "CUSTOMER_FACING_CUWOS" "SELF_SERVICE" "PAYMENTS"

The purposes for which this device shall be used (related to customer-facing UI).

Responses

200

Service successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

put/org/{org-id}/devices/{device-id}/customer-facing-ui-services/{service-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/devices/{device-id}/customer-facing-ui-services/{service-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "usage_mode": "EXCLUSIVE",
  • "purposes":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "usage_mode": "EXCLUSIVE",
  • "purposes":
    [
    ]
}

Devices: enforePOS devices

Iterate over enforePOS devices.

Returns enforePOS devices, sorted in ascending order by id.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

service_location_id
string

When specified, only devices for the specified service location are returned.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/enforepos-devices

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/enforepos-devices

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Load an enforePOS device

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

enforepos-device-id
required
string

ID of the enforePOS device to act upon

Responses

200

enforePOS device is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/enforepos-devices/{enforepos-device-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/enforepos-devices/{enforepos-device-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "default_peripherals":
    {
    },
  • "customer_facing_ui_configuration":
    {
    },
  • "sales_order_taking_configuration":
    {
    },
  • "sales_history_configuration":
    {
    },
  • "offers_and_invoicing_module_configuration":
    {
    },
  • "barcode_scanning_configuration":
    {
    },
  • "cash_register_id": "string"
}

Update an enforePOS device

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

enforepos-device-id
required
string

ID of the enforePOS device to act upon

Request Body schema: application/json
default_peripherals
object (EnforePOSDeviceDefaultPeripherals)

Structure holding information about what other devices are used by an enforePOS device.

This configuration represents the default. More specific device usages may be configure for more specific contexts. For example, a sales channel may specify a specific printer for pickup slips which will be used instead the default printer configured for the device.

customer_facing_ui_configuration
object (EnforePOSDeviceCustomerFacingUIConfiguration)

Configuration for customer-facing UI operations triggered by the device owning this configuration.

That is, what customer-facing UI device is used when this device wants to perform some customer-facing UI operation.

sales_order_taking_configuration
object (EnforePOSDeviceSalesOrderTakingConfiguration)
sales_history_configuration
object (EnforePOSDeviceSalesHistoryConfiguration)
offers_and_invoicing_module_configuration
object (EnforePOSDeviceOffersAndInvoicingModuleConfiguration)
barcode_scanning_configuration
object (EnforePOSDeviceBarcodeScanningConfiguration)

Responses

200

Device was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

put/org/{org-id}/enforepos-devices/{enforepos-device-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/enforepos-devices/{enforepos-device-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "default_peripherals":
    {
    },
  • "customer_facing_ui_configuration":
    {
    },
  • "sales_order_taking_configuration":
    {
    },
  • "sales_history_configuration":
    {
    },
  • "offers_and_invoicing_module_configuration":
    {
    },
  • "barcode_scanning_configuration":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "default_peripherals":
    {
    },
  • "customer_facing_ui_configuration":
    {
    },
  • "sales_order_taking_configuration":
    {
    },
  • "sales_history_configuration":
    {
    },
  • "offers_and_invoicing_module_configuration":
    {
    },
  • "barcode_scanning_configuration":
    {
    },
  • "cash_register_id": "string"
}

Partial update for an enforePOS device

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

enforepos-device-id
required
string

ID of the enforePOS device to act upon

Request Body schema: application/json
@type
required
string
EnforePOSDeviceDefaultPeripheralsUpdate
default_peripherals
required
object (EnforePOSDeviceDefaultPeripherals)

Structure holding information about what other devices are used by an enforePOS device.

This configuration represents the default. More specific device usages may be configure for more specific contexts. For example, a sales channel may specify a specific printer for pickup slips which will be used instead the default printer configured for the device.

Responses

200

Device was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

patch/org/{org-id}/enforepos-devices/{enforepos-device-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/enforepos-devices/{enforepos-device-id}

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "default_peripherals":
    {
    },
  • "customer_facing_ui_configuration":
    {
    },
  • "sales_order_taking_configuration":
    {
    },
  • "sales_history_configuration":
    {
    },
  • "offers_and_invoicing_module_configuration":
    {
    },
  • "barcode_scanning_configuration":
    {
    },
  • "cash_register_id": "string"
}

Get a list of registered consumers for enforePOS device events.

Retrieve all currently active event subscriptions.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Responses

200

List of registrations

403

Credentials missing or not sufficient

get/org/{org-id}/enforepos-device-subscriptions

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/enforepos-device-subscriptions

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Register an event consumer with the API.

If the callback URL is already registered, we return the original subscription ID. We will continue attempting to send new items to registered subscriptions until they are deleted. In case we cannot reach the endpoint, we will apply an exponential backoff.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
callback_url
required
string <uri>

The callback URL where event notifications are to be delivered. It must be HTTPS to prevent man-in-the-middle attacks.

Responses

201

Registration of subscription successful (or already subscribed)

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

Callbacks

post<no summary>
post/org/{org-id}/enforepos-device-subscriptions

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/enforepos-device-subscriptions

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Callback payload samples

Callback
POST: <no summary>
Content type
application/json
Copy
 Expand all Collapse all
{
  • "org_id": "string",
  • "items":
    [
    ],
  • "problems":
    []
}

Delete a subscription for enforePOS devices

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

subscription-id
required
string

ID of the subscription to delete

Responses

204

Subscription was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/enforepos-device-subscriptions/{subscription-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/enforepos-device-subscriptions/{subscription-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Cash Registers

Iterate over cash registers.

Returns cash registers, sorted in ascending order by id.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

service_location_id
string

When specified, only cash registers for the specified service location are returned.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/cash-registers

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/cash-registers

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Load a cash register

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

cash-register-id
required
string

ID of the cash register to act upon

Responses

200

Cash register is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/cash-registers/{cash-register-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/cash-registers/{cash-register-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "status": "PENDING",
  • "register_nr": "string",
  • "register_uuid": "string",
  • "service_location_id": "string",
  • "service_area_ids":
    [
    ],
  • "pos_sales_channel_id": "string",
  • "enforepos_device_id": "string",
  • "device_usage":
    {
    },
  • "fiscal_memory_configuration":
    {
    },
  • "electronic_payment_configuration":
    {
    }
}

Update a cash register

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

cash-register-id
required
string

ID of the cash register to act upon

Request Body schema: application/json
service_area_ids
Array of strings

The IDs of the service areas covered by this cash register.

device_usage
object (CashRegisterDeviceUsage)

Structure holding information about what other devices are used by a cash register.

fiscal_memory_configuration
object (CashRegisterFiscalMemoryConfiguration)

Configuration of the fiscal memory for a cash register

electronic_payment_configuration
object (CashRegisterElectronicPaymentConfiguration)

Configuration of the fiscal memory for a cash register

Responses

200

Cash register was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

post/org/{org-id}/cash-registers/{cash-register-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/cash-registers/{cash-register-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "service_area_ids":
    [
    ],
  • "device_usage":
    {
    },
  • "fiscal_memory_configuration":
    {
    },
  • "electronic_payment_configuration":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "status": "PENDING",
  • "register_nr": "string",
  • "register_uuid": "string",
  • "service_location_id": "string",
  • "service_area_ids":
    [
    ],
  • "pos_sales_channel_id": "string",
  • "enforepos_device_id": "string",
  • "device_usage":
    {
    },
  • "fiscal_memory_configuration":
    {
    },
  • "electronic_payment_configuration":
    {
    }
}

Get a list of registered consumers for cash register events.

Retrieve all currently active event subscriptions.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Responses

200

List of registrations

403

Credentials missing or not sufficient

get/org/{org-id}/cash-register-subscriptions

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/cash-register-subscriptions

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Register an event consumer with the API.

If the callback URL is already registered, we return the original subscription ID. We will continue attempting to send new items to registered subscriptions until they are deleted. In case we cannot reach the endpoint, we will apply an exponential backoff.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
callback_url
required
string <uri>

The callback URL where event notifications are to be delivered. It must be HTTPS to prevent man-in-the-middle attacks.

Responses

201

Registration of subscription successful (or already subscribed)

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

Callbacks

post<no summary>
post/org/{org-id}/cash-register-subscriptions

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/cash-register-subscriptions

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Callback payload samples

Callback
POST: <no summary>
Content type
application/json
Copy
 Expand all Collapse all
{
  • "org_id": "string",
  • "items":
    [
    ],
  • "problems":
    []
}

Delete a subscription for cash registers

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

subscription-id
required
string

ID of the subscription to delete

Responses

204

Subscription was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/cash-register-subscriptions/{subscription-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/cash-register-subscriptions/{subscription-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Accounting Configurations

Iterate over accounting configurations

Returns accounting configurations, sorted in ascending order by id.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

shared_configurations_only
boolean

When TRUE, only shared configurations (i.e., the ones not owned by any device) are returned.

default_configuration_only
boolean

When TRUE, only the default configuration is returned.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/accounting-configurations

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/accounting-configurations

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Add a new accounting configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
name
required
string
description
string
money_transfer_settings
required
object (MoneyTransferSettings)

Settings for money transfers.

safebag_settings
required
object (SafebagSettings)

Settings for safebags.

cash_management_settings
required
object (CashManagementSettings)

Settings related to management of cash.

business_day_management_settings
required
object (LocationBusinessDayManagementSettings)

Settings that control the management of the service location's business day.

personal_drawing_and_deposit_settings
required
object (PersonalDrawingAndDepositSettings)

Settings for personal drawings/deposits

Responses

201

Configuration has successfully been added

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

409

Resource(s) could not be processed because of a conflict in the current state of the resource

422

Specified data is semantically incorrect.

post/org/{org-id}/accounting-configurations

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/accounting-configurations

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "money_transfer_settings":
    {
    },
  • "safebag_settings":
    {
    },
  • "cash_management_settings":
    {
    },
  • "business_day_management_settings":
    {
    },
  • "personal_drawing_and_deposit_settings":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_service_location_id": "string",
  • "money_transfer_settings":
    {
    },
  • "safebag_settings":
    {
    },
  • "cash_management_settings":
    {
    },
  • "business_day_management_settings":
    {
    },
  • "personal_drawing_and_deposit_settings":
    {
    }
}

Load an accounting configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Responses

200

Configuration is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/accounting-configurations/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/accounting-configurations/{configuration-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_service_location_id": "string",
  • "money_transfer_settings":
    {
    },
  • "safebag_settings":
    {
    },
  • "cash_management_settings":
    {
    },
  • "business_day_management_settings":
    {
    },
  • "personal_drawing_and_deposit_settings":
    {
    }
}

Update an accounting configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Request Body schema: application/json
name
required
string
description
string
money_transfer_settings
required
object (MoneyTransferSettings)

Settings for money transfers.

safebag_settings
required
object (SafebagSettings)

Settings for safebags.

cash_management_settings
required
object (CashManagementSettings)

Settings related to management of cash.

business_day_management_settings
required
object (LocationBusinessDayManagementSettings)

Settings that control the management of the service location's business day.

personal_drawing_and_deposit_settings
required
object (PersonalDrawingAndDepositSettings)

Settings for personal drawings/deposits

Responses

200

Configuration was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

put/org/{org-id}/accounting-configurations/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/accounting-configurations/{configuration-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "money_transfer_settings":
    {
    },
  • "safebag_settings":
    {
    },
  • "cash_management_settings":
    {
    },
  • "business_day_management_settings":
    {
    },
  • "personal_drawing_and_deposit_settings":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_service_location_id": "string",
  • "money_transfer_settings":
    {
    },
  • "safebag_settings":
    {
    },
  • "cash_management_settings":
    {
    },
  • "business_day_management_settings":
    {
    },
  • "personal_drawing_and_deposit_settings":
    {
    }
}

Delete an accounting configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Responses

204

Configuration was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

delete/org/{org-id}/accounting-configurations/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/accounting-configurations/{configuration-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

External License Keys Configuration

Load the external license keys configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Responses

200

Configuration is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/external-license-keys-configuration

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/external-license-keys-configuration

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "scandit_license_key": "string"
}

Set or replace the external license keys configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
scandit_license_key
string

Responses

200

Configuration was updated successfully

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

422

Specified data is semantically incorrect.

put/org/{org-id}/external-license-keys-configuration

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/external-license-keys-configuration

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "scandit_license_key": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "scandit_license_key": "string"
}

Delete the external license keys configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Responses

204

Configuration was deleted successfully

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

delete/org/{org-id}/external-license-keys-configuration

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/external-license-keys-configuration

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Inventory Management Configurations

Iterate over inventory management configurations

Returns inventory management configurations, sorted in ascending order by id.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

shared_configurations_only
boolean

When TRUE, only shared configurations (i.e., the ones not owned by any location) are returned.

default_configuration_only
boolean

When TRUE, only the default configuration is returned.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/inventory-management-configurations

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/inventory-management-configurations

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Add a new inventory management configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
name
required
string
description
string
owning_sales_channel
object (SalesChannelReference)
settings_per_tag
required
Array of objects (InventoryManagementSettingsForTag)

Holds the inventory management settings on a "per tag" level.

For each inventory management tag, at most a single entry may be present in the list.

Responses

201

Configuration has successfully been added

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

409

Resource(s) could not be processed because of a conflict in the current state of the resource

422

Specified data is semantically incorrect.

post/org/{org-id}/inventory-management-configurations

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/inventory-management-configurations

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "owning_sales_channel":
    {
    },
  • "settings_per_tag":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_sales_channel":
    {
    },
  • "settings_per_tag":
    [
    ]
}

Load an inventory management configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Responses

200

Configuration is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/inventory-management-configurations/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/inventory-management-configurations/{configuration-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_sales_channel":
    {
    },
  • "settings_per_tag":
    [
    ]
}

Update an inventory management configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Request Body schema: application/json
name
required
string
description
string
owning_sales_channel
object (SalesChannelReference)
settings_per_tag
required
Array of objects (InventoryManagementSettingsForTag)

Holds the inventory management settings on a "per tag" level.

For each inventory management tag, at most a single entry may be present in the list.

Responses

200

Configuration was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

put/org/{org-id}/inventory-management-configurations/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/inventory-management-configurations/{configuration-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "owning_sales_channel":
    {
    },
  • "settings_per_tag":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_sales_channel":
    {
    },
  • "settings_per_tag":
    [
    ]
}

Delete an inventory management configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Responses

204

Configuration was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

delete/org/{org-id}/inventory-management-configurations/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/inventory-management-configurations/{configuration-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Goods-in Configurations

Iterate over goods-in configurations

Returns goods-in configurations, sorted in ascending order by id.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

shared_configurations_only
boolean

When TRUE, only shared configurations (i.e., the ones not owned by any location) are returned.

default_configuration_only
boolean

When TRUE, only the default configuration is returned.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/goods-in-configurations

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/goods-in-configurations

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Add a new goods-in configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
name
required
string
description
string
receipt_settings
required
object (GoodsInReceiptSettings)

Settings related to the "receipt" functionality of a goods-in.

review_settings
required
object (GoodsInReviewSettings)

Settings related to the "review" functionality of a goods-in.

resolution_settings
required
object (GoodsInResolutionSettings)

Settings related to the "resolution" functionality of a goods-in.

lifecycle_exception_settings
required
object (GoodsInLifecycleExceptionSettings)

Settings related to exceptions to the regular goods-in lifecycle.

ui_settings
required
object (GoodsInUISettings)

Settings that control the goods-in UI of the enforePOS client.

Responses

201

Configuration has successfully been added

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

409

Resource(s) could not be processed because of a conflict in the current state of the resource

422

Specified data is semantically incorrect.

post/org/{org-id}/goods-in-configurations

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/goods-in-configurations

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "receipt_settings":
    {
    },
  • "review_settings":
    {
    },
  • "resolution_settings":
    {
    },
  • "lifecycle_exception_settings":
    {
    },
  • "ui_settings":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_processing_location_id": "string",
  • "receipt_settings":
    {
    },
  • "review_settings":
    {
    },
  • "resolution_settings":
    {
    },
  • "lifecycle_exception_settings":
    {
    },
  • "ui_settings":
    {
    }
}

Load a goods-in configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Responses

200

Configuration is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/goods-in-configurations/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/goods-in-configurations/{configuration-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_processing_location_id": "string",
  • "receipt_settings":
    {
    },
  • "review_settings":
    {
    },
  • "resolution_settings":
    {
    },
  • "lifecycle_exception_settings":
    {
    },
  • "ui_settings":
    {
    }
}

Update a goods-in configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Request Body schema: application/json
name
required
string
description
string
receipt_settings
required
object (GoodsInReceiptSettings)

Settings related to the "receipt" functionality of a goods-in.

review_settings
required
object (GoodsInReviewSettings)

Settings related to the "review" functionality of a goods-in.

resolution_settings
required
object (GoodsInResolutionSettings)

Settings related to the "resolution" functionality of a goods-in.

lifecycle_exception_settings
required
object (GoodsInLifecycleExceptionSettings)

Settings related to exceptions to the regular goods-in lifecycle.

ui_settings
required
object (GoodsInUISettings)

Settings that control the goods-in UI of the enforePOS client.

Responses

200

Configuration was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

put/org/{org-id}/goods-in-configurations/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/goods-in-configurations/{configuration-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "receipt_settings":
    {
    },
  • "review_settings":
    {
    },
  • "resolution_settings":
    {
    },
  • "lifecycle_exception_settings":
    {
    },
  • "ui_settings":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_processing_location_id": "string",
  • "receipt_settings":
    {
    },
  • "review_settings":
    {
    },
  • "resolution_settings":
    {
    },
  • "lifecycle_exception_settings":
    {
    },
  • "ui_settings":
    {
    }
}

Delete a goods-in configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Responses

204

Configuration was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

delete/org/{org-id}/goods-in-configurations/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/goods-in-configurations/{configuration-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Goods-out Configurations

Iterate over goods-out configurations

Returns goods-out configurations, sorted in ascending order by id.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

shared_configurations_only
boolean

When TRUE, only shared configurations (i.e., the ones not owned by any location) are returned.

default_configuration_only
boolean

When TRUE, only the default configuration is returned.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/goods-out-configurations

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/goods-out-configurations

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Add a new goods-out configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
name
required
string
description
string
confirmation_settings
required
object (GoodsOutConfirmationSettings)

Settings related to the "confirmation" functionality of a goods-out.

picking_settings
required
object (GoodsOutPickingSettings)

Settings related to the "picking" functionality of a goods-out.

packing_settings
required
object (GoodsOutPackingSettings)

Settings related to the "packing" functionality of a goods-out.

fulfillment_settings
required
object (GoodsOutFulfillmentSettings)

Settings related to the "fulfillment" functionality of a goods-out.

The term "fulfillment" here means the phase starting with packages being picked-up by the customer/delivery staff up to and including them being delivered (when applicable) and the goods-out being marked as completed.

lifecycle_exception_settings
required
object (GoodsOutLifecycleExceptionSettings)

Settings related to exceptions to the regular goods-out lifecycle.

ui_settings
required
object (GoodsOutUISettings)

Settings that control the goods-out UI of the enforePOS client.

Responses

201

Configuration has successfully been added

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

409

Resource(s) could not be processed because of a conflict in the current state of the resource

422

Specified data is semantically incorrect.

post/org/{org-id}/goods-out-configurations

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/goods-out-configurations

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "confirmation_settings":
    {
    },
  • "picking_settings":
    {
    },
  • "packing_settings":
    {
    },
  • "fulfillment_settings":
    {
    },
  • "lifecycle_exception_settings":
    {
    },
  • "ui_settings":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_processing_location_id": "string",
  • "confirmation_settings":
    {
    },
  • "picking_settings":
    {
    },
  • "packing_settings":
    {
    },
  • "fulfillment_settings":
    {
    },
  • "lifecycle_exception_settings":
    {
    },
  • "ui_settings":
    {
    }
}

Load a goods-out configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Responses

200

Configuration is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/goods-out-configurations/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/goods-out-configurations/{configuration-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_processing_location_id": "string",
  • "confirmation_settings":
    {
    },
  • "picking_settings":
    {
    },
  • "packing_settings":
    {
    },
  • "fulfillment_settings":
    {
    },
  • "lifecycle_exception_settings":
    {
    },
  • "ui_settings":
    {
    }
}

Update a goods-out configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Request Body schema: application/json
name
required
string
description
string
confirmation_settings
required
object (GoodsOutConfirmationSettings)

Settings related to the "confirmation" functionality of a goods-out.

picking_settings
required
object (GoodsOutPickingSettings)

Settings related to the "picking" functionality of a goods-out.

packing_settings
required
object (GoodsOutPackingSettings)

Settings related to the "packing" functionality of a goods-out.

fulfillment_settings
required
object (GoodsOutFulfillmentSettings)

Settings related to the "fulfillment" functionality of a goods-out.

The term "fulfillment" here means the phase starting with packages being picked-up by the customer/delivery staff up to and including them being delivered (when applicable) and the goods-out being marked as completed.

lifecycle_exception_settings
required
object (GoodsOutLifecycleExceptionSettings)

Settings related to exceptions to the regular goods-out lifecycle.

ui_settings
required
object (GoodsOutUISettings)

Settings that control the goods-out UI of the enforePOS client.

Responses

200

Configuration was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

put/org/{org-id}/goods-out-configurations/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/goods-out-configurations/{configuration-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "confirmation_settings":
    {
    },
  • "picking_settings":
    {
    },
  • "packing_settings":
    {
    },
  • "fulfillment_settings":
    {
    },
  • "lifecycle_exception_settings":
    {
    },
  • "ui_settings":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_processing_location_id": "string",
  • "confirmation_settings":
    {
    },
  • "picking_settings":
    {
    },
  • "packing_settings":
    {
    },
  • "fulfillment_settings":
    {
    },
  • "lifecycle_exception_settings":
    {
    },
  • "ui_settings":
    {
    }
}

Delete a goods-out configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Responses

204

Configuration was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

delete/org/{org-id}/goods-out-configurations/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/goods-out-configurations/{configuration-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Manual Stock Modification Configurations

Iterate over manual stock modification configurations

Returns manual stock modification configurations, sorted in ascending order by id.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

shared_configurations_only
boolean

When TRUE, only shared configurations (i.e., the ones not owned by any location) are returned.

default_configuration_only
boolean

When TRUE, only the default configuration is returned.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/manual-stock-modification-configurations

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/manual-stock-modification-configurations

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Add a new manual stock modification configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
name
required
string
description
string
stock_count_operation_settings
required
object (StockCountOperationSettings)

Settings related to operations for modifying stock counts.

stock_blockage_operation_settings
required
object (StockBlockageOperationSettings)

Settings related to operations related to blocking and unblocking stock.

stock_requalification_operation_settings
required
object (StockRequalificationOperationSettings)

Settings related to operations for requalifying stock.

stock_conversion_operation_settings
required
object (StockConversionOperationSettings)

Settings related to operations for stock conversions.

stock_transfer_operation_settings
required
object (StockTransferOperationSettings)

Settings related to stock transfer operations.

undo_operation_settings
required
object (UndoOperationSettings)

Settings related to undo operations.

missing_data_waiver_settings
required
object (MissingDataWaiverSettings)

Settings for missing data waivers for MSM.

storage_location_compatibility_settings
required
object (StorageLocationCompatibilitySettings)

Settings for storage location compatibility for MSM.

Responses

201

Configuration has successfully been added

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

409

Resource(s) could not be processed because of a conflict in the current state of the resource

422

Specified data is semantically incorrect.

post/org/{org-id}/manual-stock-modification-configurations

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/manual-stock-modification-configurations

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "stock_count_operation_settings":
    {
    },
  • "stock_blockage_operation_settings":
    {
    },
  • "stock_requalification_operation_settings":
    {
    },
  • "stock_conversion_operation_settings":
    {
    },
  • "stock_transfer_operation_settings":
    {
    },
  • "undo_operation_settings":
    {
    },
  • "missing_data_waiver_settings":
    {
    },
  • "storage_location_compatibility_settings":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_service_location_id": "string",
  • "stock_count_operation_settings":
    {
    },
  • "stock_blockage_operation_settings":
    {
    },
  • "stock_requalification_operation_settings":
    {
    },
  • "stock_conversion_operation_settings":
    {
    },
  • "stock_transfer_operation_settings":
    {
    },
  • "undo_operation_settings":
    {
    },
  • "missing_data_waiver_settings":
    {
    },
  • "storage_location_compatibility_settings":
    {
    }
}

Load a manual stock modification configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Responses

200

Configuration is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/manual-stock-modification-configurations/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/manual-stock-modification-configurations/{configuration-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_service_location_id": "string",
  • "stock_count_operation_settings":
    {
    },
  • "stock_blockage_operation_settings":
    {
    },
  • "stock_requalification_operation_settings":
    {
    },
  • "stock_conversion_operation_settings":
    {
    },
  • "stock_transfer_operation_settings":
    {
    },
  • "undo_operation_settings":
    {
    },
  • "missing_data_waiver_settings":
    {
    },
  • "storage_location_compatibility_settings":
    {
    }
}

Update a manual stock modification configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Request Body schema: application/json
name
required
string
description
string
stock_count_operation_settings
required
object (StockCountOperationSettings)

Settings related to operations for modifying stock counts.

stock_blockage_operation_settings
required
object (StockBlockageOperationSettings)

Settings related to operations related to blocking and unblocking stock.

stock_requalification_operation_settings
required
object (StockRequalificationOperationSettings)

Settings related to operations for requalifying stock.

stock_conversion_operation_settings
required
object (StockConversionOperationSettings)

Settings related to operations for stock conversions.

stock_transfer_operation_settings
required
object (StockTransferOperationSettings)

Settings related to stock transfer operations.

undo_operation_settings
required
object (UndoOperationSettings)

Settings related to undo operations.

missing_data_waiver_settings
required
object (MissingDataWaiverSettings)

Settings for missing data waivers for MSM.

storage_location_compatibility_settings
required
object (StorageLocationCompatibilitySettings)

Settings for storage location compatibility for MSM.

Responses

200

Configuration was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

put/org/{org-id}/manual-stock-modification-configurations/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/manual-stock-modification-configurations/{configuration-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "stock_count_operation_settings":
    {
    },
  • "stock_blockage_operation_settings":
    {
    },
  • "stock_requalification_operation_settings":
    {
    },
  • "stock_conversion_operation_settings":
    {
    },
  • "stock_transfer_operation_settings":
    {
    },
  • "undo_operation_settings":
    {
    },
  • "missing_data_waiver_settings":
    {
    },
  • "storage_location_compatibility_settings":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_service_location_id": "string",
  • "stock_count_operation_settings":
    {
    },
  • "stock_blockage_operation_settings":
    {
    },
  • "stock_requalification_operation_settings":
    {
    },
  • "stock_conversion_operation_settings":
    {
    },
  • "stock_transfer_operation_settings":
    {
    },
  • "undo_operation_settings":
    {
    },
  • "missing_data_waiver_settings":
    {
    },
  • "storage_location_compatibility_settings":
    {
    }
}

Delete a manual stock modification configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Responses

204

Configuration was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

delete/org/{org-id}/manual-stock-modification-configurations/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/manual-stock-modification-configurations/{configuration-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Sales History Configurations

Iterate over sales history configurations

Returns sales history configurations, sorted in ascending order by id.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

shared_configurations_only
boolean

When TRUE, only shared configurations (i.e., the ones not owned by any device) are returned.

default_configuration_only
boolean

When TRUE, only the default configuration is returned.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/sales-history-configurations

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/sales-history-configurations

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Add a new sales history configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
name
required
string
description
string
payment_settings
required
object (SalesHistoryPaymentSettings)

Configuration for payment settings for the sales history UI.

void_settings
required
object (SalesHistoryVoidSettings)

Configuration for void operations for the sales history UI.

receipt_settings
required
object (SalesHistoryReceiptSettings)

Configuration for receipts for the sales history UI.

Responses

201

Configuration has successfully been added

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

409

Resource(s) could not be processed because of a conflict in the current state of the resource

422

Specified data is semantically incorrect.

post/org/{org-id}/sales-history-configurations

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/sales-history-configurations

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "payment_settings":
    {
    },
  • "void_settings":
    {
    },
  • "receipt_settings":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_enforepos_device_id": "string",
  • "payment_settings":
    {
    },
  • "void_settings":
    {
    },
  • "receipt_settings":
    {
    }
}

Load a sales history configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Responses

200

Configuration is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/sales-history-configurations/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/sales-history-configurations/{configuration-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_enforepos_device_id": "string",
  • "payment_settings":
    {
    },
  • "void_settings":
    {
    },
  • "receipt_settings":
    {
    }
}

Update a sales history configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Request Body schema: application/json
name
required
string
description
string
payment_settings
required
object (SalesHistoryPaymentSettings)

Configuration for payment settings for the sales history UI.

void_settings
required
object (SalesHistoryVoidSettings)

Configuration for void operations for the sales history UI.

receipt_settings
required
object (SalesHistoryReceiptSettings)

Configuration for receipts for the sales history UI.

Responses

200

Configuration was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

put/org/{org-id}/sales-history-configurations/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/sales-history-configurations/{configuration-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "payment_settings":
    {
    },
  • "void_settings":
    {
    },
  • "receipt_settings":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_enforepos_device_id": "string",
  • "payment_settings":
    {
    },
  • "void_settings":
    {
    },
  • "receipt_settings":
    {
    }
}

Delete a sales history configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Responses

204

Configuration was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

delete/org/{org-id}/sales-history-configurations/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/sales-history-configurations/{configuration-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Sales Order Taking Configurations: OTC

Iterate over OTC sales order taking configurations

Returns OTC sales order taking configurations, sorted in ascending order by id.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

shared_configurations_only
boolean

When TRUE, only shared configurations (i.e., the ones not owned by any device) are returned.

default_configuration_only
boolean

When TRUE, only the default configuration is returned.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/sales-order-taking-configurations/otc

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/sales-order-taking-configurations/otc

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Add a new OTC sales order taking configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
name
required
string
description
string
general_settings
required
object (OTCSalesOrderTakingSettings)

Configuration settings specific for OTC sales order taking UI.

customer_settings
required
object (SalesOrderCustomerSettings)

Settings controlling the selection and handling of customers for sales orders in an order-taking UI.

recorded_for_settings
required
object (SalesOrderRecordedForSettings)

Settings controlling the selection and handling of "recorded for" entities for sales orders in an order-taking UI.

tag_settings
required
object (SalesOrderTagSettings)

Settings controlling the selection and handling of tags for sales orders in an order-taking UI.

ui_settings
required
object (SalesOrderTakingUISettings)

Holds configuration settings for the UI elements of an order taking UI.

For example, the settings here allow the merchant to configure which elements are present in the toolbars above/below the basket.

line_item_settings
object (SalesOrderLineItemSettings)

Configuration settings related to line items for sales order taking UIs.

dining_settings
required
object (SalesOrderDiningSettings)

Configuration specific for dining settings for OTC sales order taking UI.

reservation_settings
required
object (SalesOrderReservationSettings)

Configuration specific for reservation settings for (processing) OTC sales order taking UI.

pricing_and_discount_settings
required
object (SalesOrderPricingAndDiscountSettings)

Configuration settings related to pricing and discounts for sales order taking UIs.

payment_settings
required
object (SalesOrderPaymentSettings)

Configuration specific for payment settings for OTC,f ulfillment and self service sales order taking UIs.

receipt_settings
required
object (SalesOrderReceiptSettings)

Configuration specific for receipt settings for OTC, fulfillment and self service sales order taking UIs.

customer_facing_ui_settings
object (CustomerFacingUISettings)

Configuration specific for customer facing ui that could be displayed on configured customer displays for sales order taking UIs.

sales_item_navigation_id
required
string [ 1 .. 256 ] characters

The ID of the sales item navigation used by this order taking config.

floor_plan_definition_id
string [ 1 .. 256 ] characters

The ID of the floor plan definition used for this sales order taking.

Responses

201

Configuration has successfully been added

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

409

Resource(s) could not be processed because of a conflict in the current state of the resource

422

Specified data is semantically incorrect.

post/org/{org-id}/sales-order-taking-configurations/otc

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/sales-order-taking-configurations/otc

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "general_settings":
    {
    },
  • "customer_settings":
    {
    },
  • "recorded_for_settings":
    {
    },
  • "tag_settings":
    {
    },
  • "ui_settings":
    {
    },
  • "line_item_settings":
    {
    },
  • "dining_settings":
    {
    },
  • "reservation_settings":
    {
    },
  • "pricing_and_discount_settings":
    {
    },
  • "payment_settings":
    {
    },
  • "receipt_settings":
    {
    },
  • "customer_facing_ui_settings":
    {
    },
  • "sales_item_navigation_id": "string",
  • "floor_plan_definition_id": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_enforepos_device_id": "string",
  • "general_settings":
    {
    },
  • "customer_settings":
    {
    },
  • "recorded_for_settings":
    {
    },
  • "tag_settings":
    {
    },
  • "ui_settings":
    {
    },
  • "line_item_settings":
    {
    },
  • "dining_settings":
    {
    },
  • "reservation_settings":
    {
    },
  • "pricing_and_discount_settings":
    {
    },
  • "payment_settings":
    {
    },
  • "receipt_settings":
    {
    },
  • "customer_facing_ui_settings":
    {
    },
  • "sales_item_navigation_id": "string",
  • "floor_plan_definition_id": "string"
}

Load an OTC sales order taking configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Responses

200

Configuration is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/sales-order-taking-configurations/otc/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/sales-order-taking-configurations/otc/{configuration-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_enforepos_device_id": "string",
  • "general_settings":
    {
    },
  • "customer_settings":
    {
    },
  • "recorded_for_settings":
    {
    },
  • "tag_settings":
    {
    },
  • "ui_settings":
    {
    },
  • "line_item_settings":
    {
    },
  • "dining_settings":
    {
    },
  • "reservation_settings":
    {
    },
  • "pricing_and_discount_settings":
    {
    },
  • "payment_settings":
    {
    },
  • "receipt_settings":
    {
    },
  • "customer_facing_ui_settings":
    {
    },
  • "sales_item_navigation_id": "string",
  • "floor_plan_definition_id": "string"
}

Update an OTC sales order taking configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Request Body schema: application/json
name
required
string
description
string
general_settings
required
object (OTCSalesOrderTakingSettings)

Configuration settings specific for OTC sales order taking UI.

customer_settings
required
object (SalesOrderCustomerSettings)

Settings controlling the selection and handling of customers for sales orders in an order-taking UI.

recorded_for_settings
required
object (SalesOrderRecordedForSettings)

Settings controlling the selection and handling of "recorded for" entities for sales orders in an order-taking UI.

tag_settings
required
object (SalesOrderTagSettings)

Settings controlling the selection and handling of tags for sales orders in an order-taking UI.

ui_settings
required
object (SalesOrderTakingUISettings)

Holds configuration settings for the UI elements of an order taking UI.

For example, the settings here allow the merchant to configure which elements are present in the toolbars above/below the basket.

line_item_settings
object (SalesOrderLineItemSettings)

Configuration settings related to line items for sales order taking UIs.

dining_settings
required
object (SalesOrderDiningSettings)

Configuration specific for dining settings for OTC sales order taking UI.

reservation_settings
required
object (SalesOrderReservationSettings)

Configuration specific for reservation settings for (processing) OTC sales order taking UI.

pricing_and_discount_settings
required
object (SalesOrderPricingAndDiscountSettings)

Configuration settings related to pricing and discounts for sales order taking UIs.

payment_settings
required
object (SalesOrderPaymentSettings)

Configuration specific for payment settings for OTC,f ulfillment and self service sales order taking UIs.

receipt_settings
required
object (SalesOrderReceiptSettings)

Configuration specific for receipt settings for OTC, fulfillment and self service sales order taking UIs.

customer_facing_ui_settings
object (CustomerFacingUISettings)

Configuration specific for customer facing ui that could be displayed on configured customer displays for sales order taking UIs.

sales_item_navigation_id
required
string [ 1 .. 256 ] characters

The ID of the sales item navigation used by this order taking config.

floor_plan_definition_id
string [ 1 .. 256 ] characters

The ID of the floor plan definition used for this sales order taking.

Responses

200

Configuration was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

put/org/{org-id}/sales-order-taking-configurations/otc/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/sales-order-taking-configurations/otc/{configuration-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "general_settings":
    {
    },
  • "customer_settings":
    {
    },
  • "recorded_for_settings":
    {
    },
  • "tag_settings":
    {
    },
  • "ui_settings":
    {
    },
  • "line_item_settings":
    {
    },
  • "dining_settings":
    {
    },
  • "reservation_settings":
    {
    },
  • "pricing_and_discount_settings":
    {
    },
  • "payment_settings":
    {
    },
  • "receipt_settings":
    {
    },
  • "customer_facing_ui_settings":
    {
    },
  • "sales_item_navigation_id": "string",
  • "floor_plan_definition_id": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_enforepos_device_id": "string",
  • "general_settings":
    {
    },
  • "customer_settings":
    {
    },
  • "recorded_for_settings":
    {
    },
  • "tag_settings":
    {
    },
  • "ui_settings":
    {
    },
  • "line_item_settings":
    {
    },
  • "dining_settings":
    {
    },
  • "reservation_settings":
    {
    },
  • "pricing_and_discount_settings":
    {
    },
  • "payment_settings":
    {
    },
  • "receipt_settings":
    {
    },
  • "customer_facing_ui_settings":
    {
    },
  • "sales_item_navigation_id": "string",
  • "floor_plan_definition_id": "string"
}

Delete an OTC sales order taking configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Responses

204

Configuration was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

delete/org/{org-id}/sales-order-taking-configurations/otc/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/sales-order-taking-configurations/otc/{configuration-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Sales Order Taking Configurations: Processing OTC

Iterate over "processing OTC" sales order taking configurations

Returns "processing OTC" sales order taking configurations, sorted in ascending order by id.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

shared_configurations_only
boolean

When TRUE, only shared configurations (i.e., the ones not owned by any device) are returned.

default_configuration_only
boolean

When TRUE, only the default configuration is returned.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/sales-order-taking-configurations/processing-otc

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/sales-order-taking-configurations/processing-otc

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Add a new "processing OTC" sales order taking configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
name
required
string
description
string
general_settings
required
object (ProcessingOTCSalesOrderTakingSettings)

Configuration settings specific for "processing OTC" sales order taking UI.

customer_settings
required
object (SalesOrderCustomerSettings)

Settings controlling the selection and handling of customers for sales orders in an order-taking UI.

recorded_for_settings
required
object (SalesOrderRecordedForSettings)

Settings controlling the selection and handling of "recorded for" entities for sales orders in an order-taking UI.

tag_settings
required
object (SalesOrderTagSettings)

Settings controlling the selection and handling of tags for sales orders in an order-taking UI.

ui_settings
required
object (SalesOrderTakingUISettings)

Holds configuration settings for the UI elements of an order taking UI.

For example, the settings here allow the merchant to configure which elements are present in the toolbars above/below the basket.

line_item_settings
object (SalesOrderLineItemSettings)

Configuration settings related to line items for sales order taking UIs.

dining_settings
required
object (SalesOrderDiningSettings)

Configuration specific for dining settings for OTC sales order taking UI.

reservation_settings
required
object (SalesOrderReservationSettings)

Configuration specific for reservation settings for (processing) OTC sales order taking UI.

pricing_and_discount_settings
required
object (SalesOrderPricingAndDiscountSettings)

Configuration settings related to pricing and discounts for sales order taking UIs.

payment_settings
required
object (SalesOrderPaymentSettings)

Configuration specific for payment settings for OTC,f ulfillment and self service sales order taking UIs.

receipt_settings
required
object (SalesOrderReceiptSettings)

Configuration specific for receipt settings for OTC, fulfillment and self service sales order taking UIs.

customer_facing_ui_settings
object (CustomerFacingUISettings)

Configuration specific for customer facing ui that could be displayed on configured customer displays for sales order taking UIs.

sales_item_navigation_id
required
string [ 1 .. 256 ] characters

The ID of the sales item navigation used by this order taking config.

floor_plan_definition_id
string [ 1 .. 256 ] characters

The ID of the floor plan definition used for this sales order taking.

Responses

201

Configuration has successfully been added

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

409

Resource(s) could not be processed because of a conflict in the current state of the resource

422

Specified data is semantically incorrect.

post/org/{org-id}/sales-order-taking-configurations/processing-otc

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/sales-order-taking-configurations/processing-otc

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "general_settings":
    {
    },
  • "customer_settings":
    {
    },
  • "recorded_for_settings":
    {
    },
  • "tag_settings":
    {
    },
  • "ui_settings":
    {
    },
  • "line_item_settings":
    {
    },
  • "dining_settings":
    {
    },
  • "reservation_settings":
    {
    },
  • "pricing_and_discount_settings":
    {
    },
  • "payment_settings":
    {
    },
  • "receipt_settings":
    {
    },
  • "customer_facing_ui_settings":
    {
    },
  • "sales_item_navigation_id": "string",
  • "floor_plan_definition_id": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_enforepos_device_id": "string",
  • "general_settings":
    {
    },
  • "customer_settings":
    {
    },
  • "recorded_for_settings":
    {
    },
  • "tag_settings":
    {
    },
  • "ui_settings":
    {
    },
  • "line_item_settings":
    {
    },
  • "dining_settings":
    {
    },
  • "reservation_settings":
    {
    },
  • "pricing_and_discount_settings":
    {
    },
  • "payment_settings":
    {
    },
  • "receipt_settings":
    {
    },
  • "customer_facing_ui_settings":
    {
    },
  • "sales_item_navigation_id": "string",
  • "floor_plan_definition_id": "string"
}

Load a "processing OTC" sales order taking configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Responses

200

Configuration is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/sales-order-taking-configurations/processing-otc/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/sales-order-taking-configurations/processing-otc/{configuration-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_enforepos_device_id": "string",
  • "general_settings":
    {
    },
  • "customer_settings":
    {
    },
  • "recorded_for_settings":
    {
    },
  • "tag_settings":
    {
    },
  • "ui_settings":
    {
    },
  • "line_item_settings":
    {
    },
  • "dining_settings":
    {
    },
  • "reservation_settings":
    {
    },
  • "pricing_and_discount_settings":
    {
    },
  • "payment_settings":
    {
    },
  • "receipt_settings":
    {
    },
  • "customer_facing_ui_settings":
    {
    },
  • "sales_item_navigation_id": "string",
  • "floor_plan_definition_id": "string"
}

Update a "processing OTC" sales order taking configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Request Body schema: application/json
name
required
string
description
string
general_settings
required
object (ProcessingOTCSalesOrderTakingSettings)

Configuration settings specific for "processing OTC" sales order taking UI.

customer_settings
required
object (SalesOrderCustomerSettings)

Settings controlling the selection and handling of customers for sales orders in an order-taking UI.

recorded_for_settings
required
object (SalesOrderRecordedForSettings)

Settings controlling the selection and handling of "recorded for" entities for sales orders in an order-taking UI.

tag_settings
required
object (SalesOrderTagSettings)

Settings controlling the selection and handling of tags for sales orders in an order-taking UI.

ui_settings
required
object (SalesOrderTakingUISettings)

Holds configuration settings for the UI elements of an order taking UI.

For example, the settings here allow the merchant to configure which elements are present in the toolbars above/below the basket.

line_item_settings
object (SalesOrderLineItemSettings)

Configuration settings related to line items for sales order taking UIs.

dining_settings
required
object (SalesOrderDiningSettings)

Configuration specific for dining settings for OTC sales order taking UI.

reservation_settings
required
object (SalesOrderReservationSettings)

Configuration specific for reservation settings for (processing) OTC sales order taking UI.

pricing_and_discount_settings
required
object (SalesOrderPricingAndDiscountSettings)

Configuration settings related to pricing and discounts for sales order taking UIs.

payment_settings
required
object (SalesOrderPaymentSettings)

Configuration specific for payment settings for OTC,f ulfillment and self service sales order taking UIs.

receipt_settings
required
object (SalesOrderReceiptSettings)

Configuration specific for receipt settings for OTC, fulfillment and self service sales order taking UIs.

customer_facing_ui_settings
object (CustomerFacingUISettings)

Configuration specific for customer facing ui that could be displayed on configured customer displays for sales order taking UIs.

sales_item_navigation_id
required
string [ 1 .. 256 ] characters

The ID of the sales item navigation used by this order taking config.

floor_plan_definition_id
string [ 1 .. 256 ] characters

The ID of the floor plan definition used for this sales order taking.

Responses

200

Configuration was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

put/org/{org-id}/sales-order-taking-configurations/processing-otc/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/sales-order-taking-configurations/processing-otc/{configuration-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "general_settings":
    {
    },
  • "customer_settings":
    {
    },
  • "recorded_for_settings":
    {
    },
  • "tag_settings":
    {
    },
  • "ui_settings":
    {
    },
  • "line_item_settings":
    {
    },
  • "dining_settings":
    {
    },
  • "reservation_settings":
    {
    },
  • "pricing_and_discount_settings":
    {
    },
  • "payment_settings":
    {
    },
  • "receipt_settings":
    {
    },
  • "customer_facing_ui_settings":
    {
    },
  • "sales_item_navigation_id": "string",
  • "floor_plan_definition_id": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_enforepos_device_id": "string",
  • "general_settings":
    {
    },
  • "customer_settings":
    {
    },
  • "recorded_for_settings":
    {
    },
  • "tag_settings":
    {
    },
  • "ui_settings":
    {
    },
  • "line_item_settings":
    {
    },
  • "dining_settings":
    {
    },
  • "reservation_settings":
    {
    },
  • "pricing_and_discount_settings":
    {
    },
  • "payment_settings":
    {
    },
  • "receipt_settings":
    {
    },
  • "customer_facing_ui_settings":
    {
    },
  • "sales_item_navigation_id": "string",
  • "floor_plan_definition_id": "string"
}

Delete a "processing OTC" sales order taking configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Responses

204

Configuration was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

delete/org/{org-id}/sales-order-taking-configurations/processing-otc/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/sales-order-taking-configurations/processing-otc/{configuration-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Sales Order Taking Configurations: Self Service OTC

Iterate over self-service OTC sales order taking configurations

Returns self-service OTC sales order taking configurations, sorted in ascending order by id.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

shared_configurations_only
boolean

When TRUE, only shared configurations (i.e., the ones not owned by any device) are returned.

default_configuration_only
boolean

When TRUE, only the default configuration is returned.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/sales-order-taking-configurations/self-service-otc

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/sales-order-taking-configurations/self-service-otc

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Add a new self-service OTC sales order taking configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
name
required
string
description
string
supported_self_service_types
required
Array of strings (SelfServiceType)
Items Enum: "TABLE_SERVICE" "PICKUP_INHOUSE" "PICKUP_TAKE_AWAY"

The list of self servie types supported by this configuration.

customer_settings
required
object (SalesOrderCustomerSettings)

Settings controlling the selection and handling of customers for sales orders in an order-taking UI.

recorded_for_settings
required
object (SalesOrderRecordedForSettings)

Settings controlling the selection and handling of "recorded for" entities for sales orders in an order-taking UI.

tag_settings
required
object (SalesOrderTagSettings)

Settings controlling the selection and handling of tags for sales orders in an order-taking UI.

payment_settings
required
object (SalesOrderPaymentSettings)

Configuration specific for payment settings for OTC,f ulfillment and self service sales order taking UIs.

receipt_settings
required
object (SalesOrderReceiptSettings)

Configuration specific for receipt settings for OTC, fulfillment and self service sales order taking UIs.

device_settings
required
object (SelfServiceDeviceSettings)

Configuration of generic device settings in self service.

order_settings
required
object (SelfServiceOrderSettings)

Configuration of order handling in self service.

available_idle_screen_configurations
Array of objects (IdleScreenConfiguration)

The list of available configurations for the idle screen during self-service operations.

A device configured for self service will use the first configuration with a matching timeConstraints or the first configuration that has an empty timeConstraints if a matching one is not available.

sales_item_navigation_id
required
string [ 1 .. 256 ] characters

The ID of the sales item navigation used by this order taking config.

Responses

201

Configuration has successfully been added

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

409

Resource(s) could not be processed because of a conflict in the current state of the resource

422

Specified data is semantically incorrect.

post/org/{org-id}/sales-order-taking-configurations/self-service-otc

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/sales-order-taking-configurations/self-service-otc

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "supported_self_service_types":
    [
    ],
  • "customer_settings":
    {
    },
  • "recorded_for_settings":
    {
    },
  • "tag_settings":
    {
    },
  • "payment_settings":
    {
    },
  • "receipt_settings":
    {
    },
  • "device_settings":
    {
    },
  • "order_settings":
    {
    },
  • "available_idle_screen_configurations":
    [
    ],
  • "sales_item_navigation_id": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_enforepos_device_id": "string",
  • "supported_self_service_types":
    [
    ],
  • "customer_settings":
    {
    },
  • "recorded_for_settings":
    {
    },
  • "tag_settings":
    {
    },
  • "payment_settings":
    {
    },
  • "receipt_settings":
    {
    },
  • "device_settings":
    {
    },
  • "order_settings":
    {
    },
  • "available_idle_screen_configurations":
    [
    ],
  • "sales_item_navigation_id": "string"
}

Load a self-service OTC sales order taking configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Responses

200

Configuration is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/sales-order-taking-configurations/self-service-otc/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/sales-order-taking-configurations/self-service-otc/{configuration-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_enforepos_device_id": "string",
  • "supported_self_service_types":
    [
    ],
  • "customer_settings":
    {
    },
  • "recorded_for_settings":
    {
    },
  • "tag_settings":
    {
    },
  • "payment_settings":
    {
    },
  • "receipt_settings":
    {
    },
  • "device_settings":
    {
    },
  • "order_settings":
    {
    },
  • "available_idle_screen_configurations":
    [
    ],
  • "sales_item_navigation_id": "string"
}

Update a self-service OTC sales order taking configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Request Body schema: application/json
name
required
string
description
string
supported_self_service_types
required
Array of strings (SelfServiceType)
Items Enum: "TABLE_SERVICE" "PICKUP_INHOUSE" "PICKUP_TAKE_AWAY"

The list of self servie types supported by this configuration.

customer_settings
required
object (SalesOrderCustomerSettings)

Settings controlling the selection and handling of customers for sales orders in an order-taking UI.

recorded_for_settings
required
object (SalesOrderRecordedForSettings)

Settings controlling the selection and handling of "recorded for" entities for sales orders in an order-taking UI.

tag_settings
required
object (SalesOrderTagSettings)

Settings controlling the selection and handling of tags for sales orders in an order-taking UI.

payment_settings
required
object (SalesOrderPaymentSettings)

Configuration specific for payment settings for OTC,f ulfillment and self service sales order taking UIs.

receipt_settings
required
object (SalesOrderReceiptSettings)

Configuration specific for receipt settings for OTC, fulfillment and self service sales order taking UIs.

device_settings
required
object (SelfServiceDeviceSettings)

Configuration of generic device settings in self service.

order_settings
required
object (SelfServiceOrderSettings)

Configuration of order handling in self service.

available_idle_screen_configurations
Array of objects (IdleScreenConfiguration)

The list of available configurations for the idle screen during self-service operations.

A device configured for self service will use the first configuration with a matching timeConstraints or the first configuration that has an empty timeConstraints if a matching one is not available.

sales_item_navigation_id
required
string [ 1 .. 256 ] characters

The ID of the sales item navigation used by this order taking config.

Responses

200

Configuration was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

put/org/{org-id}/sales-order-taking-configurations/self-service-otc/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/sales-order-taking-configurations/self-service-otc/{configuration-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "supported_self_service_types":
    [
    ],
  • "customer_settings":
    {
    },
  • "recorded_for_settings":
    {
    },
  • "tag_settings":
    {
    },
  • "payment_settings":
    {
    },
  • "receipt_settings":
    {
    },
  • "device_settings":
    {
    },
  • "order_settings":
    {
    },
  • "available_idle_screen_configurations":
    [
    ],
  • "sales_item_navigation_id": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_enforepos_device_id": "string",
  • "supported_self_service_types":
    [
    ],
  • "customer_settings":
    {
    },
  • "recorded_for_settings":
    {
    },
  • "tag_settings":
    {
    },
  • "payment_settings":
    {
    },
  • "receipt_settings":
    {
    },
  • "device_settings":
    {
    },
  • "order_settings":
    {
    },
  • "available_idle_screen_configurations":
    [
    ],
  • "sales_item_navigation_id": "string"
}

Delete a self-service OTC sales order taking configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Responses

204

Configuration was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

delete/org/{org-id}/sales-order-taking-configurations/self-service-otc/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/sales-order-taking-configurations/self-service-otc/{configuration-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Sales Order Taking Configurations: Fulfillment

Iterate over fulfillment sales order taking configurations

Returns fulfillment sales order taking configurations, sorted in ascending order by id.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

shared_configurations_only
boolean

When TRUE, only shared configurations (i.e., the ones not owned by any device) are returned.

default_configuration_only
boolean

When TRUE, only the default configuration is returned.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/sales-order-taking-configurations/fulfillment

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/sales-order-taking-configurations/fulfillment

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Add a new fulfillment sales order taking configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
name
required
string
description
string
general_settings
required
object (FulfillmentSalesOrderTakingSettings)

Configuration settings specific for "fulfillment" sales order taking UI.

customer_settings
required
object (SalesOrderCustomerSettings)

Settings controlling the selection and handling of customers for sales orders in an order-taking UI.

recorded_for_settings
required
object (SalesOrderRecordedForSettings)

Settings controlling the selection and handling of "recorded for" entities for sales orders in an order-taking UI.

tag_settings
required
object (SalesOrderTagSettings)

Settings controlling the selection and handling of tags for sales orders in an order-taking UI.

ui_settings
required
object (SalesOrderTakingUISettings)

Holds configuration settings for the UI elements of an order taking UI.

For example, the settings here allow the merchant to configure which elements are present in the toolbars above/below the basket.

line_item_settings
object (SalesOrderLineItemSettings)

Configuration settings related to line items for sales order taking UIs.

fulfillment_settings
required
object (SalesOrderFulfillmentSettings)

Configuration settings specific for fulfillment sales order taking UI.

pricing_and_discount_settings
required
object (SalesOrderPricingAndDiscountSettings)

Configuration settings related to pricing and discounts for sales order taking UIs.

payment_settings
required
object (SalesOrderPaymentSettings)

Configuration specific for payment settings for OTC,f ulfillment and self service sales order taking UIs.

receipt_settings
required
object (SalesOrderReceiptSettings)

Configuration specific for receipt settings for OTC, fulfillment and self service sales order taking UIs.

customer_facing_ui_settings
object (CustomerFacingUISettings)

Configuration specific for customer facing ui that could be displayed on configured customer displays for sales order taking UIs.

sales_item_navigation_id
required
string [ 1 .. 256 ] characters

The ID of the sales item navigation used by this order taking config.

Responses

201

Configuration has successfully been added

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

409

Resource(s) could not be processed because of a conflict in the current state of the resource

422

Specified data is semantically incorrect.

post/org/{org-id}/sales-order-taking-configurations/fulfillment

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/sales-order-taking-configurations/fulfillment

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "general_settings":
    {
    },
  • "customer_settings":
    {
    },
  • "recorded_for_settings":
    {
    },
  • "tag_settings":
    {
    },
  • "ui_settings":
    {
    },
  • "line_item_settings":
    {
    },
  • "fulfillment_settings":
    {
    },
  • "pricing_and_discount_settings":
    {
    },
  • "payment_settings":
    {
    },
  • "receipt_settings":
    {
    },
  • "customer_facing_ui_settings":
    {
    },
  • "sales_item_navigation_id": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_enforepos_device_id": "string",
  • "general_settings":
    {
    },
  • "customer_settings":
    {
    },
  • "recorded_for_settings":
    {
    },
  • "tag_settings":
    {
    },
  • "ui_settings":
    {
    },
  • "line_item_settings":
    {
    },
  • "fulfillment_settings":
    {
    },
  • "pricing_and_discount_settings":
    {
    },
  • "payment_settings":
    {
    },
  • "receipt_settings":
    {
    },
  • "customer_facing_ui_settings":
    {
    },
  • "sales_item_navigation_id": "string"
}

Load a fulfillment sales order taking configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Responses

200

Configuration is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/sales-order-taking-configurations/fulfillment/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/sales-order-taking-configurations/fulfillment/{configuration-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_enforepos_device_id": "string",
  • "general_settings":
    {
    },
  • "customer_settings":
    {
    },
  • "recorded_for_settings":
    {
    },
  • "tag_settings":
    {
    },
  • "ui_settings":
    {
    },
  • "line_item_settings":
    {
    },
  • "fulfillment_settings":
    {
    },
  • "pricing_and_discount_settings":
    {
    },
  • "payment_settings":
    {
    },
  • "receipt_settings":
    {
    },
  • "customer_facing_ui_settings":
    {
    },
  • "sales_item_navigation_id": "string"
}

Update a fulfillment sales order taking configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Request Body schema: application/json
name
required
string
description
string
general_settings
required
object (FulfillmentSalesOrderTakingSettings)

Configuration settings specific for "fulfillment" sales order taking UI.

customer_settings
required
object (SalesOrderCustomerSettings)

Settings controlling the selection and handling of customers for sales orders in an order-taking UI.

recorded_for_settings
required
object (SalesOrderRecordedForSettings)

Settings controlling the selection and handling of "recorded for" entities for sales orders in an order-taking UI.

tag_settings
required
object (SalesOrderTagSettings)

Settings controlling the selection and handling of tags for sales orders in an order-taking UI.

ui_settings
required
object (SalesOrderTakingUISettings)

Holds configuration settings for the UI elements of an order taking UI.

For example, the settings here allow the merchant to configure which elements are present in the toolbars above/below the basket.

line_item_settings
object (SalesOrderLineItemSettings)

Configuration settings related to line items for sales order taking UIs.

fulfillment_settings
required
object (SalesOrderFulfillmentSettings)

Configuration settings specific for fulfillment sales order taking UI.

pricing_and_discount_settings
required
object (SalesOrderPricingAndDiscountSettings)

Configuration settings related to pricing and discounts for sales order taking UIs.

payment_settings
required
object (SalesOrderPaymentSettings)

Configuration specific for payment settings for OTC,f ulfillment and self service sales order taking UIs.

receipt_settings
required
object (SalesOrderReceiptSettings)

Configuration specific for receipt settings for OTC, fulfillment and self service sales order taking UIs.

customer_facing_ui_settings
object (CustomerFacingUISettings)

Configuration specific for customer facing ui that could be displayed on configured customer displays for sales order taking UIs.

sales_item_navigation_id
required
string [ 1 .. 256 ] characters

The ID of the sales item navigation used by this order taking config.

Responses

200

Configuration was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

put/org/{org-id}/sales-order-taking-configurations/fulfillment/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/sales-order-taking-configurations/fulfillment/{configuration-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "general_settings":
    {
    },
  • "customer_settings":
    {
    },
  • "recorded_for_settings":
    {
    },
  • "tag_settings":
    {
    },
  • "ui_settings":
    {
    },
  • "line_item_settings":
    {
    },
  • "fulfillment_settings":
    {
    },
  • "pricing_and_discount_settings":
    {
    },
  • "payment_settings":
    {
    },
  • "receipt_settings":
    {
    },
  • "customer_facing_ui_settings":
    {
    },
  • "sales_item_navigation_id": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_enforepos_device_id": "string",
  • "general_settings":
    {
    },
  • "customer_settings":
    {
    },
  • "recorded_for_settings":
    {
    },
  • "tag_settings":
    {
    },
  • "ui_settings":
    {
    },
  • "line_item_settings":
    {
    },
  • "fulfillment_settings":
    {
    },
  • "pricing_and_discount_settings":
    {
    },
  • "payment_settings":
    {
    },
  • "receipt_settings":
    {
    },
  • "customer_facing_ui_settings":
    {
    },
  • "sales_item_navigation_id": "string"
}

Delete a fulfillment sales order taking configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Responses

204

Configuration was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

delete/org/{org-id}/sales-order-taking-configurations/fulfillment/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/sales-order-taking-configurations/fulfillment/{configuration-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Offers & Invoicing Module Configurations

Iterate over offers module configurations

Returns offers module configurations, sorted in ascending order by id.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

shared_configurations_only
boolean

When TRUE, only shared configurations (i.e., the ones not owned by any device) are returned.

default_configuration_only
boolean

When TRUE, only the default configuration is returned.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/offers-module-configurations

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/offers-module-configurations

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Add a new offers module configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
name
required
string
description
string
general_settings
required
object (OffersModuleGeneralSettings)

General settings for the "Offers" module.

pricing_and_discount_settings
required
object (SalesOrderPricingAndDiscountSettings)

Configuration settings related to pricing and discounts for sales order taking UIs.

line_item_settings
required
object (OffersModuleLineItemSettings)

Configuration settings related to line items for the "Offers" module.

ui_settings
required
object (SalesOrderTakingUISettings)

Holds configuration settings for the UI elements of an order taking UI.

For example, the settings here allow the merchant to configure which elements are present in the toolbars above/below the basket.

sales_item_navigation_id
required
string [ 1 .. 256 ] characters

The ID of the sales item navigation used for creating offers.

Responses

201

Configuration has successfully been added

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

409

Resource(s) could not be processed because of a conflict in the current state of the resource

422

Specified data is semantically incorrect.

post/org/{org-id}/offers-module-configurations

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/offers-module-configurations

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "general_settings":
    {
    },
  • "pricing_and_discount_settings":
    {
    },
  • "line_item_settings":
    {
    },
  • "ui_settings":
    {
    },
  • "sales_item_navigation_id": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_enforepos_device_id": "string",
  • "general_settings":
    {
    },
  • "pricing_and_discount_settings":
    {
    },
  • "line_item_settings":
    {
    },
  • "ui_settings":
    {
    },
  • "sales_item_navigation_id": "string"
}

Load an offers module configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Responses

200

Configuration is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/offers-module-configurations/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/offers-module-configurations/{configuration-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_enforepos_device_id": "string",
  • "general_settings":
    {
    },
  • "pricing_and_discount_settings":
    {
    },
  • "line_item_settings":
    {
    },
  • "ui_settings":
    {
    },
  • "sales_item_navigation_id": "string"
}

Update an offers module configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Request Body schema: application/json
name
required
string
description
string
general_settings
required
object (OffersModuleGeneralSettings)

General settings for the "Offers" module.

pricing_and_discount_settings
required
object (SalesOrderPricingAndDiscountSettings)

Configuration settings related to pricing and discounts for sales order taking UIs.

line_item_settings
required
object (OffersModuleLineItemSettings)

Configuration settings related to line items for the "Offers" module.

ui_settings
required
object (SalesOrderTakingUISettings)

Holds configuration settings for the UI elements of an order taking UI.

For example, the settings here allow the merchant to configure which elements are present in the toolbars above/below the basket.

sales_item_navigation_id
required
string [ 1 .. 256 ] characters

The ID of the sales item navigation used for creating offers.

Responses

200

Configuration was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

put/org/{org-id}/offers-module-configurations/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/offers-module-configurations/{configuration-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "general_settings":
    {
    },
  • "pricing_and_discount_settings":
    {
    },
  • "line_item_settings":
    {
    },
  • "ui_settings":
    {
    },
  • "sales_item_navigation_id": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_enforepos_device_id": "string",
  • "general_settings":
    {
    },
  • "pricing_and_discount_settings":
    {
    },
  • "line_item_settings":
    {
    },
  • "ui_settings":
    {
    },
  • "sales_item_navigation_id": "string"
}

Delete an offers module configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Responses

204

Configuration was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

delete/org/{org-id}/offers-module-configurations/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/offers-module-configurations/{configuration-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Iterate over invoicing module configurations

Returns invoicing module configurations, sorted in ascending order by id.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

shared_configurations_only
boolean

When TRUE, only shared configurations (i.e., the ones not owned by any device) are returned.

default_configuration_only
boolean

When TRUE, only the default configuration is returned.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/invoicing-module-configurations

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/invoicing-module-configurations

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Add a new invoicing module configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
name
required
string
description
string
general_settings
required
object (InvoicingModuleGeneralSettings)

General settings for the "Invoicing" module.

recorded_for_settings
required
object (SalesOrderRecordedForSettings)

Settings controlling the selection and handling of "recorded for" entities for sales orders in an order-taking UI.

tag_settings
required
object (SalesOrderTagSettings)

Settings controlling the selection and handling of tags for sales orders in an order-taking UI.

receipt_settings
required
object (InvoicingModuleReceiptSettings)

Configuration settings related to receipts for the "Invoicing" module.

pricing_and_discount_settings
required
object (SalesOrderPricingAndDiscountSettings)

Configuration settings related to pricing and discounts for sales order taking UIs.

line_item_settings
required
object (InvoicingModuleLineItemSettings)

Configuration settings related to line items for the "Invoicing" module.

ui_settings
required
object (SalesOrderTakingUISettings)

Holds configuration settings for the UI elements of an order taking UI.

For example, the settings here allow the merchant to configure which elements are present in the toolbars above/below the basket.

sales_item_navigation_id
required
string [ 1 .. 256 ] characters

The ID of the sales item navigation used for creating invoices.

Responses

201

Configuration has successfully been added

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

409

Resource(s) could not be processed because of a conflict in the current state of the resource

422

Specified data is semantically incorrect.

post/org/{org-id}/invoicing-module-configurations

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/invoicing-module-configurations

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "general_settings":
    {
    },
  • "recorded_for_settings":
    {
    },
  • "tag_settings":
    {
    },
  • "receipt_settings":
    {
    },
  • "pricing_and_discount_settings":
    {
    },
  • "line_item_settings":
    {
    },
  • "ui_settings":
    {
    },
  • "sales_item_navigation_id": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_enforepos_device_id": "string",
  • "general_settings":
    {
    },
  • "recorded_for_settings":
    {
    },
  • "tag_settings":
    {
    },
  • "receipt_settings":
    {
    },
  • "pricing_and_discount_settings":
    {
    },
  • "line_item_settings":
    {
    },
  • "ui_settings":
    {
    },
  • "sales_item_navigation_id": "string"
}

Load an invoicing module configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Responses

200

Configuration is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/invoicing-module-configurations/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/invoicing-module-configurations/{configuration-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_enforepos_device_id": "string",
  • "general_settings":
    {
    },
  • "recorded_for_settings":
    {
    },
  • "tag_settings":
    {
    },
  • "receipt_settings":
    {
    },
  • "pricing_and_discount_settings":
    {
    },
  • "line_item_settings":
    {
    },
  • "ui_settings":
    {
    },
  • "sales_item_navigation_id": "string"
}

Update an invoicing module configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Request Body schema: application/json
name
required
string
description
string
general_settings
required
object (InvoicingModuleGeneralSettings)

General settings for the "Invoicing" module.

recorded_for_settings
required
object (SalesOrderRecordedForSettings)

Settings controlling the selection and handling of "recorded for" entities for sales orders in an order-taking UI.

tag_settings
required
object (SalesOrderTagSettings)

Settings controlling the selection and handling of tags for sales orders in an order-taking UI.

receipt_settings
required
object (InvoicingModuleReceiptSettings)

Configuration settings related to receipts for the "Invoicing" module.

pricing_and_discount_settings
required
object (SalesOrderPricingAndDiscountSettings)

Configuration settings related to pricing and discounts for sales order taking UIs.

line_item_settings
required
object (InvoicingModuleLineItemSettings)

Configuration settings related to line items for the "Invoicing" module.

ui_settings
required
object (SalesOrderTakingUISettings)

Holds configuration settings for the UI elements of an order taking UI.

For example, the settings here allow the merchant to configure which elements are present in the toolbars above/below the basket.

sales_item_navigation_id
required
string [ 1 .. 256 ] characters

The ID of the sales item navigation used for creating invoices.

Responses

200

Configuration was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

put/org/{org-id}/invoicing-module-configurations/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/invoicing-module-configurations/{configuration-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "general_settings":
    {
    },
  • "recorded_for_settings":
    {
    },
  • "tag_settings":
    {
    },
  • "receipt_settings":
    {
    },
  • "pricing_and_discount_settings":
    {
    },
  • "line_item_settings":
    {
    },
  • "ui_settings":
    {
    },
  • "sales_item_navigation_id": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default": true,
  • "owning_enforepos_device_id": "string",
  • "general_settings":
    {
    },
  • "recorded_for_settings":
    {
    },
  • "tag_settings":
    {
    },
  • "receipt_settings":
    {
    },
  • "pricing_and_discount_settings":
    {
    },
  • "line_item_settings":
    {
    },
  • "ui_settings":
    {
    },
  • "sales_item_navigation_id": "string"
}

Delete an invoicing module configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Responses

204

Configuration was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

delete/org/{org-id}/invoicing-module-configurations/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/invoicing-module-configurations/{configuration-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Idle Screen Configurations

Iterate over idle screen configurations

Returns idle screen configurations, sorted in ascending order by id.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

shared_configurations_only
boolean

When TRUE, only shared configurations (i.e., the ones not owned by any device) are returned.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/idle-screen-configurations

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/idle-screen-configurations

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Add a new idle screen configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
name
required
string

Option shorter name

description
string

Option longer description

is_default_for
string (AudienceType)
Enum: "STAFF" "CUSTOMERS"
  • STAFF
  • CUSTOMERS
owner
object (OwnerReference)
background
required
any (Background)
widget_layout
any (WidgetLayout)

Responses

201

Configuration has successfully been added

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

409

Resource(s) could not be processed because of a conflict in the current state of the resource

422

Specified data is semantically incorrect.

post/org/{org-id}/idle-screen-configurations

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/idle-screen-configurations

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "is_default_for": "STAFF",
  • "owner":
    {
    },
  • "background":
    {
    },
  • "widget_layout":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default_for": "STAFF",
  • "owner":
    {
    },
  • "background":
    {
    },
  • "widget_layout":
    {
    }
}

Load an idle screen configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Responses

200

Configuration is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/idle-screen-configurations/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/idle-screen-configurations/{configuration-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default_for": "STAFF",
  • "owner":
    {
    },
  • "background":
    {
    },
  • "widget_layout":
    {
    }
}

Update an idle screen configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Request Body schema: application/json
name
required
string

Option shorter name

description
string

Option longer description

is_default_for
string (AudienceType)
Enum: "STAFF" "CUSTOMERS"
  • STAFF
  • CUSTOMERS
owner
object (OwnerReference)
background
required
any (Background)
widget_layout
any (WidgetLayout)

Responses

200

Configuration was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

put/org/{org-id}/idle-screen-configurations/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/idle-screen-configurations/{configuration-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "is_default_for": "STAFF",
  • "owner":
    {
    },
  • "background":
    {
    },
  • "widget_layout":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_default_for": "STAFF",
  • "owner":
    {
    },
  • "background":
    {
    },
  • "widget_layout":
    {
    }
}

Delete an idle screen configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

configuration-id
required
string

ID of the configuration to act upon

Responses

204

Configuration was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

delete/org/{org-id}/idle-screen-configurations/{configuration-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/idle-screen-configurations/{configuration-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Connected Shipping Services

List shipping services sorted by name.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

Responses

200

List of connected shipping services

get/org/{org-id}/connected-shipping-services

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/connected-shipping-services

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Create a new connected shipping service

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
name
required
string

The name of the shipping carrier.

base_url
required
string

The base url which is called e.g. for requesting the labels.

credentials_key
string

The credentialsKey to access the baseUrl.

package_constraints_config
object (PackageConstraintsConfig)

Package constraints and requirements given by the shipping carrier or specific to the shipping service.

Responses

200

Created connected shipping services

post/org/{org-id}/connected-shipping-services

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/connected-shipping-services

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "base_url": "string",
  • "credentials_key": "string",
  • "package_constraints_config":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "base_url": "string",
  • "credentials_key": "string",
  • "package_constraints_config":
    {
    }
}

Update a connected shipping service

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

shipping-service-id
required
string

ID of the shipping service to act upon

Request Body schema: application/json
name
required
string

The name of the shipping carrier.

base_url
required
string

The base url which is called e.g. for requesting the labels.

credentials_key
string

The credentialsKey to access the baseUrl.

package_constraints_config
object (PackageConstraintsConfig)

Package constraints and requirements given by the shipping carrier or specific to the shipping service.

Responses

200

Updated connected shipping service

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

put/org/{org-id}/connected-shipping-services/{shipping-service-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/connected-shipping-services/{shipping-service-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "base_url": "string",
  • "credentials_key": "string",
  • "package_constraints_config":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "base_url": "string",
  • "credentials_key": "string",
  • "package_constraints_config":
    {
    }
}

Remove a connected shipping service

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

shipping-service-id
required
string

ID of the shipping service to act upon

Responses

204

Connected Shipping Service was successfully removed.

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/connected-shipping-services/{shipping-service-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/connected-shipping-services/{shipping-service-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

External Invoicing Methods

Iterate over basic external invoicing methods

Returns basic external invoicing methods, sorted in ascending order by id.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/basic-external-invoicing-methods

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/basic-external-invoicing-methods

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Add a new basic external invoicing method

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
name
required
string
is_active
required
boolean
Default: true

Flag indicating whether the EPM is "active". Only active BasicExternalInvoicingMethods are available in the invoicing/payout UI.

external_id
string

Optional external identifier of the external invoicing method.

Responses

201

EIM has successfully been added

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

409

Resource(s) could not be processed because of a conflict in the current state of the resource

422

Specified data is semantically incorrect.

post/org/{org-id}/basic-external-invoicing-methods

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/basic-external-invoicing-methods

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "is_active": true,
  • "external_id": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "is_active": true,
  • "external_id": "string"
}

Load a basic external invoicing method

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

eim-id
required
string

ID of the external invoicing method to act upon

Responses

200

EIM is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/basic-external-invoicing-methods/{eim-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/basic-external-invoicing-methods/{eim-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "is_active": true,
  • "external_id": "string"
}

Update a basic external invoicing method

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

eim-id
required
string

ID of the external invoicing method to act upon

Request Body schema: application/json
is_active
boolean
Default: true

Flag indicating whether the method is "active". Only active methods are available in the invoicing/payout UI.

Responses

200

EIM was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

patch/org/{org-id}/basic-external-invoicing-methods/{eim-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/basic-external-invoicing-methods/{eim-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "is_active": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "is_active": true,
  • "external_id": "string"
}

Iterate over cuwo-based external invoicing methods

Returns cuwo-based external invoicing methods, sorted in ascending order by id.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/cuwo-based-external-invoicing-methods

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/cuwo-based-external-invoicing-methods

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Add a new cuwo-based external invoicing method

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
name
required
string
is_active
required
boolean
Default: true

Flag indicating whether the EPM is "active". Only active CUWOBasedExternalInvoicingMethods are available in the invoicing/payout UI.

external_id
string

Optional external identifier of the external invoicing method.

cuwo_config
required
object (CustomWorkflowConfigForEIMs)

Holds information about the custom workflows defined for handling payment-related logic for a CUWO-based external payment method.

Responses

201

EIM has successfully been added

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

409

Resource(s) could not be processed because of a conflict in the current state of the resource

422

Specified data is semantically incorrect.

post/org/{org-id}/cuwo-based-external-invoicing-methods

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/cuwo-based-external-invoicing-methods

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "is_active": true,
  • "external_id": "string",
  • "cuwo_config":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "is_active": true,
  • "external_id": "string",
  • "cuwo_config":
    {
    }
}

Load a cuwo-based external invoicing method

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

eim-id
required
string

ID of the external invoicing method to act upon

Responses

200

EIM is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/cuwo-based-external-invoicing-methods/{eim-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/cuwo-based-external-invoicing-methods/{eim-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "is_active": true,
  • "external_id": "string",
  • "cuwo_config":
    {
    }
}

Update a cuwo-based external invoicing method

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

eim-id
required
string

ID of the external invoicing method to act upon

Request Body schema: application/json
is_active
boolean

Flag indicating whether the method is "active". Only active methods are available in the invoicing/payout UI.

cuwo_config
object (CustomWorkflowConfigForEIMs)

Holds information about the custom workflows defined for handling payment-related logic for a CUWO-based external payment method.

Responses

200

EIM was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

patch/org/{org-id}/cuwo-based-external-invoicing-methods/{eim-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/cuwo-based-external-invoicing-methods/{eim-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "is_active": true,
  • "cuwo_config":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "is_active": true,
  • "external_id": "string",
  • "cuwo_config":
    {
    }
}

External Payment Methods

Iterate over basic external payment methods

Returns basic external payment methods, sorted in ascending order by id.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/external-payment-methods

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/external-payment-methods

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Add a new basic external payment method

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
name
required
string
is_active
required
boolean
Default: true

Flag indicating whether the EPM is "active". Only active ExternalPaymentMethods are available in the payment/payout UI.

external_id
string

Optional external identifier of the external payment method.

image_id
string [ 1 .. 256 ] characters

The ID of the image to show for the external payment method in the payment/payout UI. This is a V1 image!

requires_reference
required
boolean

Specifies whether an "external reference" string must be provided when a payment using this external payment method is recorded.

supports_credit_payments
required
boolean

If set to true, the payment method can be used for credit (incoming) payments.

supports_debit_payments
required
boolean

If set to true, the payment method can be used for debit (outgoing) payments (aka payouts).

account_type
required
string (ExternalPaymentMethodAccountType)
Default: "MONEY"
Enum: "LIABILITY" "ACCOUNTS_RECEIVABLE" "MONEY"
settlement_account
object (AccountRef)

Responses

201

EPM has successfully been added

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

409

Resource(s) could not be processed because of a conflict in the current state of the resource

422

Specified data is semantically incorrect.

post/org/{org-id}/external-payment-methods

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/external-payment-methods

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "is_active": true,
  • "external_id": "string",
  • "image_id": "string",
  • "requires_reference": true,
  • "supports_credit_payments": true,
  • "supports_debit_payments": true,
  • "account_type": "MONEY",
  • "settlement_account":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "is_active": true,
  • "external_id": "string",
  • "image_id": "string",
  • "requires_reference": true,
  • "supports_credit_payments": true,
  • "supports_debit_payments": true,
  • "account_type": "MONEY",
  • "settlement_account":
    {
    }
}

Load a basic external payment method

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

epm-id
required
string

ID of the external payment method to act upon

Responses

200

EPM is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/external-payment-methods/{epm-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/external-payment-methods/{epm-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "is_active": true,
  • "external_id": "string",
  • "image_id": "string",
  • "requires_reference": true,
  • "supports_credit_payments": true,
  • "supports_debit_payments": true,
  • "account_type": "MONEY",
  • "settlement_account":
    {
    }
}

Update a basic external payment method

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

epm-id
required
string

ID of the external payment method to act upon

Request Body schema: application/json
is_active
boolean

Flag indicating whether the EPM is "active". Only active ExternalPaymentMethods are available in the payment/payout UI.

image_id
string [ 1 .. 256 ] characters

The ID of the image to show for the external payment method in the payment/payout UI. This is a V1 image!

requires_reference
boolean

Specifies whether an "external reference" string must be provided when a payment using this external payment method is recorded.

supports_credit_payments
boolean

If set to true, the payment method can be used for credit (incoming) payments.

supports_debit_payments
boolean

If set to true, the payment method can be used for debit (outgoing) payments (aka payouts).

Responses

200

EPM was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

patch/org/{org-id}/external-payment-methods/{epm-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/external-payment-methods/{epm-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "is_active": true,
  • "image_id": "string",
  • "requires_reference": true,
  • "supports_credit_payments": true,
  • "supports_debit_payments": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "is_active": true,
  • "external_id": "string",
  • "image_id": "string",
  • "requires_reference": true,
  • "supports_credit_payments": true,
  • "supports_debit_payments": true,
  • "account_type": "MONEY",
  • "settlement_account":
    {
    }
}

Iterate over cuwo-based external payment methods

Returns cuwo-based external payment methods, sorted in ascending order by id.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/cuwo-based-external-payment-methods

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/cuwo-based-external-payment-methods

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Add a new cuwo-based external payment method

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
name
required
string
is_active
required
boolean
Default: true

Flag indicating whether the EPM is "active". Only active ExternalPaymentMethods are available in the payment/payout UI.

external_id
string

Optional external identifier of the external payment method.

image_id
string [ 1 .. 256 ] characters

The ID of the image to show for the external payment method in the payment/payout UI. This is a V1 image!

supports_credit_payments
required
boolean

If set to true, the payment method can be used for credit (incoming) payments.

supports_debit_payments
required
boolean

If set to true, the payment method can be used for debit (outgoing) payments (aka payouts).

account_type
required
string (ExternalPaymentMethodAccountType)
Default: "MONEY"
Enum: "LIABILITY" "ACCOUNTS_RECEIVABLE" "MONEY"
settlement_account
object (AccountRef)
cuwo_config_for_payments
object (CustomWorkflowConfigForPayments)

Holds information about the custom workflows defined for handling payment-related logic for a CUWO-based external payment method.

cuwo_config_for_payouts
object (CustomWorkflowConfigForPayouts)

Holds information about the custom workflows defined for handling payout-related logic for a CUWO-based external payment method.

availability_check_api_access_configuration
object (ExternalAPIAccessConfiguration)

A data structure holding the configuration data needed to access an external API.

tipping_allowed
required
boolean
Default: false
partial_payments_allowed
required
boolean
Default: false
customer_identifier_constraints
Array of any (IdentifierConstraint)

A list of "identifier constraints" that describe identifiers that shall be treated as "customer identifiers" for the EPM.

Entries in the list are considered to be ORed. For example, when the list contains the two entries: * Range "a000" to "dzzz" * Range "x000" to "zzzz" The codes "b123" and "yagt" both match.

Responses

201

EPM has successfully been added

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

409

Resource(s) could not be processed because of a conflict in the current state of the resource

422

Specified data is semantically incorrect.

post/org/{org-id}/cuwo-based-external-payment-methods

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/cuwo-based-external-payment-methods

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "is_active": true,
  • "external_id": "string",
  • "image_id": "string",
  • "supports_credit_payments": true,
  • "supports_debit_payments": true,
  • "account_type": "MONEY",
  • "settlement_account":
    {
    },
  • "cuwo_config_for_payments":
    {},
  • "cuwo_config_for_payouts":
    {},
  • "availability_check_api_access_configuration":
    {
    },
  • "tipping_allowed": false,
  • "partial_payments_allowed": false,
  • "customer_identifier_constraints":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "is_active": true,
  • "external_id": "string",
  • "image_id": "string",
  • "supports_credit_payments": true,
  • "supports_debit_payments": true,
  • "account_type": "MONEY",
  • "settlement_account":
    {
    },
  • "cuwo_config_for_payments":
    {},
  • "cuwo_config_for_payouts":
    {},
  • "availability_check_api_access_configuration":
    {
    },
  • "tipping_allowed": false,
  • "partial_payments_allowed": false,
  • "customer_identifier_constraints":
    [
    ]
}

Load a cuwo-based external payment method

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

epm-id
required
string

ID of the external payment method to act upon

Responses

200

EPM is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/cuwo-based-external-payment-methods/{epm-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/cuwo-based-external-payment-methods/{epm-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "is_active": true,
  • "external_id": "string",
  • "image_id": "string",
  • "supports_credit_payments": true,
  • "supports_debit_payments": true,
  • "account_type": "MONEY",
  • "settlement_account":
    {
    },
  • "cuwo_config_for_payments":
    {},
  • "cuwo_config_for_payouts":
    {},
  • "availability_check_api_access_configuration":
    {
    },
  • "tipping_allowed": false,
  • "partial_payments_allowed": false,
  • "customer_identifier_constraints":
    [
    ]
}

Update a cuwo-based external payment method

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

epm-id
required
string

ID of the external payment method to act upon

Request Body schema: application/json
is_active
boolean

Flag indicating whether the EPM is "active". Only active ExternalPaymentMethods are available in the payment/payout UI.

image_id
string [ 1 .. 256 ] characters

The ID of the image to show for the external payment method in the payment/payout UI. This is a V1 image!

supports_credit_payments
boolean

If set to true, the payment method can be used for credit (incoming) payments.

supports_debit_payments
boolean

If set to true, the payment method can be used for debit (outgoing) payments (aka payouts).

cuwo_config_for_payments
object (CustomWorkflowConfigForPayments)

Holds information about the custom workflows defined for handling payment-related logic for a CUWO-based external payment method.

cuwo_config_for_payouts
object (CustomWorkflowConfigForPayouts)

Holds information about the custom workflows defined for handling payout-related logic for a CUWO-based external payment method.

availability_check_api_access_configuration
object (ExternalAPIAccessConfiguration)

A data structure holding the configuration data needed to access an external API.

tipping_allowed
boolean
partial_payments_allowed
boolean
customer_identifier_constraints
Array of any (IdentifierConstraint)

A list of "identifier constraints" that describe identifiers that shall be treated as "customer identifiers" for the EPM.

Entries in the list are considered to be ORed. For example, when the list contains the two entries: * Range "a000" to "dzzz" * Range "x000" to "zzzz" The codes "b123" and "yagt" both match.

Responses

200

EPM was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

patch/org/{org-id}/cuwo-based-external-payment-methods/{epm-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/cuwo-based-external-payment-methods/{epm-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "is_active": true,
  • "image_id": "string",
  • "supports_credit_payments": true,
  • "supports_debit_payments": true,
  • "cuwo_config_for_payments":
    {},
  • "cuwo_config_for_payouts":
    {},
  • "availability_check_api_access_configuration":
    {
    },
  • "tipping_allowed": true,
  • "partial_payments_allowed": true,
  • "customer_identifier_constraints":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "is_active": true,
  • "external_id": "string",
  • "image_id": "string",
  • "supports_credit_payments": true,
  • "supports_debit_payments": true,
  • "account_type": "MONEY",
  • "settlement_account":
    {
    },
  • "cuwo_config_for_payments":
    {},
  • "cuwo_config_for_payouts":
    {},
  • "availability_check_api_access_configuration":
    {
    },
  • "tipping_allowed": false,
  • "partial_payments_allowed": false,
  • "customer_identifier_constraints":
    [
    ]
}

Iterate over API-based external payment methods

Returns API-based external payment methods, sorted in ascending order by id.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/api-based-external-payment-methods

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/api-based-external-payment-methods

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Add a new API-based external payment method

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
name
required
string
is_active
required
boolean
Default: true

Flag indicating whether the EPM is "active". Only active ExternalPaymentMethods are available in the payment/payout UI.

external_id
string

Optional external identifier of the external payment method.

image_id
string [ 1 .. 256 ] characters

The ID of the image to show for the external payment method in the payment/payout UI. This is a V1 image!

supports_credit_payments
required
boolean

If set to true, the payment method can be used for credit (incoming) payments.

supports_debit_payments
required
boolean

If set to true, the payment method can be used for debit (outgoing) payments (aka payouts).

account_type
required
string (ExternalPaymentMethodAccountType)
Default: "MONEY"
Enum: "LIABILITY" "ACCOUNTS_RECEIVABLE" "MONEY"
settlement_account
object (AccountRef)
payment_api_access_configuration
required
object (ExternalAPIAccessConfiguration)

A data structure holding the configuration data needed to access an external API.

tipping_allowed
required
boolean
Default: false
partial_payments_allowed
required
boolean
Default: false
check_for_payments_without_vouchers
required
boolean
Default: false

Flag that controls whether the "payment computation" is invoked even when no payment vouchers are present. This can be used for EPMs where possible payments can be enabled externally (e.g., via a mobile app).

payment_voucher_identifier_constraints
Array of any (IdentifierConstraint)

A list of "identifier constraints" that describe identifiers that shall be treated as "payment voucher identifiers" for the EPM.

Entries in the list are considered to be ORed. For example, when the list contains the two entries: * Range "a000" to "dzzz" * Range "x000" to "zzzz" The codes "b123" and "yagt" both match.

customer_identifier_constraints
Array of any (IdentifierConstraint)

A list of "identifier constraints" that describe identifiers that shall be treated as "customer identifiers" for the EPM.

Entries in the list are considered to be ORed. For example, when the list contains the two entries: * Range "a000" to "dzzz" * Range "x000" to "zzzz" The codes "b123" and "yagt" both match.

Responses

201

EPM has successfully been added

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

409

Resource(s) could not be processed because of a conflict in the current state of the resource

422

Specified data is semantically incorrect.

post/org/{org-id}/api-based-external-payment-methods

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/api-based-external-payment-methods

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "is_active": true,
  • "external_id": "string",
  • "image_id": "string",
  • "supports_credit_payments": true,
  • "supports_debit_payments": true,
  • "account_type": "MONEY",
  • "settlement_account":
    {
    },
  • "payment_api_access_configuration":
    {
    },
  • "tipping_allowed": false,
  • "partial_payments_allowed": false,
  • "check_for_payments_without_vouchers": false,
  • "payment_voucher_identifier_constraints":
    [
    ],
  • "customer_identifier_constraints":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "is_active": true,
  • "external_id": "string",
  • "image_id": "string",
  • "supports_credit_payments": true,
  • "supports_debit_payments": true,
  • "account_type": "MONEY",
  • "settlement_account":
    {
    },
  • "payment_api_access_configuration":
    {
    },
  • "tipping_allowed": false,
  • "partial_payments_allowed": false,
  • "check_for_payments_without_vouchers": false,
  • "payment_voucher_identifier_constraints":
    [
    ],
  • "customer_identifier_constraints":
    [
    ]
}

Load an API-based external payment method

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

epm-id
required
string

ID of the external payment method to act upon

Responses

200

EPM is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/api-based-external-payment-methods/{epm-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/api-based-external-payment-methods/{epm-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "is_active": true,
  • "external_id": "string",
  • "image_id": "string",
  • "supports_credit_payments": true,
  • "supports_debit_payments": true,
  • "account_type": "MONEY",
  • "settlement_account":
    {
    },
  • "payment_api_access_configuration":
    {
    },
  • "tipping_allowed": false,
  • "partial_payments_allowed": false,
  • "check_for_payments_without_vouchers": false,
  • "payment_voucher_identifier_constraints":
    [
    ],
  • "customer_identifier_constraints":
    [
    ]
}

Update an API-based external payment method

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

epm-id
required
string

ID of the external payment method to act upon

Request Body schema: application/json
is_active
boolean

Flag indicating whether the EPM is "active". Only active ExternalPaymentMethods are available in the payment/payout UI.

image_id
string [ 1 .. 256 ] characters

The ID of the image to show for the external payment method in the payment/payout UI. This is a V1 image!

supports_credit_payments
boolean

If set to true, the payment method can be used for credit (incoming) payments.

supports_debit_payments
boolean

If set to true, the payment method can be used for debit (outgoing) payments (aka payouts).

payment_api_access_configuration
object (ExternalAPIAccessConfiguration)

A data structure holding the configuration data needed to access an external API.

tipping_allowed
boolean
partial_payments_allowed
boolean
check_for_payments_without_vouchers
boolean

Flag that controls whether the "payment computation" is invoked even when no payment vouchers are present. This can be used for EPMs where possible payments can be enabled externally (e.g., via a mobile app).

payment_voucher_identifier_constraints
Array of any (IdentifierConstraint)

A list of "identifier constraints" that describe identifiers that shall be treated as "payment voucher identifiers" for the EPM.

Entries in the list are considered to be ORed. For example, when the list contains the two entries: * Range "a000" to "dzzz" * Range "x000" to "zzzz" The codes "b123" and "yagt" both match.

customer_identifier_constraints
Array of any (IdentifierConstraint)

A list of "identifier constraints" that describe identifiers that shall be treated as "customer identifiers" for the EPM.

Entries in the list are considered to be ORed. For example, when the list contains the two entries: * Range "a000" to "dzzz" * Range "x000" to "zzzz" The codes "b123" and "yagt" both match.

Responses

200

EPM was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

patch/org/{org-id}/api-based-external-payment-methods/{epm-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/api-based-external-payment-methods/{epm-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "is_active": true,
  • "image_id": "string",
  • "supports_credit_payments": true,
  • "supports_debit_payments": true,
  • "payment_api_access_configuration":
    {
    },
  • "tipping_allowed": true,
  • "partial_payments_allowed": true,
  • "check_for_payments_without_vouchers": true,
  • "payment_voucher_identifier_constraints":
    [
    ],
  • "customer_identifier_constraints":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "is_active": true,
  • "external_id": "string",
  • "image_id": "string",
  • "supports_credit_payments": true,
  • "supports_debit_payments": true,
  • "account_type": "MONEY",
  • "settlement_account":
    {
    },
  • "payment_api_access_configuration":
    {
    },
  • "tipping_allowed": false,
  • "partial_payments_allowed": false,
  • "check_for_payments_without_vouchers": false,
  • "payment_voucher_identifier_constraints":
    [
    ],
  • "customer_identifier_constraints":
    [
    ]
}

External Document Creation Service Configuration

Load the external document creation service configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Responses

200

Configuration is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/external-document-creation-service-configuration

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/external-document-creation-service-configuration

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "use_for_document_types":
    [
    ],
  • "use_api_version": "v1",
  • "access_configuration":
    {
    }
}

Set or replace the external document creation service configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
use_for_document_types
required
Array of strings

The set of document types for which to use the external DCS.

The document types are identified by their name as defined by the DocumentType enumeration in the DCS API.

use_api_version
required
string
Default: "v1"

The API version to use for the external DCS.

This is the "vXXX" segment in the API endpoints documented for the DCS API

For example, to use the API endpoints in version "v1" (e.g, /org/{org-id}/documents/v1), the string "v1" should be stored here.

access_configuration
required
object (ExternalAPIAccessConfiguration)

A data structure holding the configuration data needed to access an external API.

Responses

200

Configuration was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

422

Specified data is semantically incorrect.

put/org/{org-id}/external-document-creation-service-configuration

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/external-document-creation-service-configuration

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "use_for_document_types":
    [
    ],
  • "use_api_version": "v1",
  • "access_configuration":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "use_for_document_types":
    [
    ],
  • "use_api_version": "v1",
  • "access_configuration":
    {
    }
}

Delete the external document creation service configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Responses

204

Configuration is successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

delete/org/{org-id}/external-document-creation-service-configuration

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/external-document-creation-service-configuration

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

External Pricing Engine Configuration

Load the external pricing engine configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Responses

200

Configuration is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/external-pricing-engine-configuration

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/external-pricing-engine-configuration

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "access_information":
    {
    },
  • "used_api_version": "string"
}

Set or replace the external pricing engine configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
access_information
required
object (ExternalPricingEngineAccessInformation)
used_api_version
string <= 30 characters

The version of the Pricing Engine API to be used. The version string must be given as three numbers with the schema "major.minor.micro". The enfore platform can support an External Pricing Engine both for enforePOS 1 and enforePOS 2 applications. For the former only the API versions < 0.2 are supported ("old" API), while for the latter also API versions >= 0.2.0 are supported ("new" API). Which version is selected by the enfore platform, depends on the used_api_version property. If it is set, the enfore platform selects the "old" API.

Responses

200

Configuration was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

422

Specified data is semantically incorrect.

put/org/{org-id}/external-pricing-engine-configuration

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/external-pricing-engine-configuration

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "access_information":
    {
    },
  • "used_api_version": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "access_information":
    {
    },
  • "used_api_version": "string"
}

Delete the external pricing engine configuration

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Responses

204

Configuration is successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

delete/org/{org-id}/external-pricing-engine-configuration

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/external-pricing-engine-configuration

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Custom Reasons

Iterate over custom reasons

Returns custom reasons, sorted in ascending order by id.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/custom-reasons

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/custom-reasons

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Add a new custom reason

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
name
required
object (LocalizedString)

Holds a text that is optionally localized to different languages.

usage_context_group
required
string (CustomReasonUsageContextGroup)
Enum: "SALES_PRICE_MODIFICATION" "VOID_SALES_INVOICES" "INVENTORY_OPERATION" "SALES_ORDER_PAYOUT_ITEMS" "SALES_ORDER_CANCELLATION" "LEDGER_OPERATION" "GOODS_IN_OPERATION" "GOODS_OUT_OPERATION" "INVENTORY_TRACKING"

Enumeration of the "usage context groups" for custom reasons.

The enfore platform supports custom reasons in a variety of usage contexts, for example for inventory operations, sales price modifications or the voiding an invoice.

Related contexts are grouped together into "usage context groups" For example, the granting of manual discounts and the setting of manual prices.

Depending on the usage context group, reasons (both platform defined as well as custom ones) are shared by all contexts of the group or are unique for each context in the group.

Therefore, when a merchant defines custom reasons, she must specify the usage context group the specific reason should be available for. And, when the usage context group uses context-specific reasons, also specify the specific usage context the reason should be available for.

Note that the configuration what specific reasons (both platform- and merchant-defined) are available for a specific usage context and in what order they are presented, is configured separately for each usage context.

  • SALES_PRICE_MODIFICATION
    Covers modifications to a sales price. This includes granting manual discounts, adding manual markups and setting a manual sales price.

  • VOID_SALES_INVOICES
    Covers the full or partial void of sales invoices.

  • INVENTORY_OPERATION
    Covers inventory operations. For now, this only includes operations triggered via manual stock modifications.

    A custom reason for this context group must have a context from the list defined by InventoryOperationUsageContext.

  • SALES_ORDER_PAYOUT_ITEMS
    Covers payout line items in sales orders.

  • SALES_ORDER_CANCELLATION
    Covers cancellations of sales orders and their line items.

    A custom reason for this context group must have a context from the list defined by SalesOrderCancellationUsageContext.

  • LEDGER_OPERATION
    Covers ledger/accounting operations. This includes recording manual money transfers, personal drawings/deposits and reconciliation operations.

    A custom reason for this context group must have a context from the list defined by AccountingOperationUsageContext.

  • GOODS_IN_OPERATION
    Covers operations related to the lifecycle of a GoodsIn.

    A custom reason for this context group must have a context from the list defined by GoodsInOperationUsageContext.

  • GOODS_OUT_OPERATION
    Covers operations related to the lifecycle of a GoodsOut.

    A custom reason for this context group must have a context from the list defined by GoodsOutOperationUsageContext.

  • INVENTORY_TRACKING
    Covers reasons used for/related to inventory tracking.

    A custom reason for this context group must have a context from the list defined by InventoryTrackingUsageContext.

usage_context
any (CustomReasonUsageContext)
archetype
required
any (ReasonArchetype)

Responses

201

Custom reason has successfully been added

409

Resource(s) could not be processed because of a conflict in the current state of the resource

422

Specified data is semantically incorrect.

post/org/{org-id}/custom-reasons

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/custom-reasons

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name":
    {
    },
  • "usage_context_group": "SALES_PRICE_MODIFICATION",
  • "usage_context":
    {
    },
  • "archetype":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name":
    {
    },
  • "usage_context_group": "SALES_PRICE_MODIFICATION",
  • "usage_context":
    {
    },
  • "archetype":
    {
    }
}

Load a custom reason

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

custom-reason-id
required
string

ID of the custom reason to act upon

Responses

200

Custom reason is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/custom-reasons/{custom-reason-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/custom-reasons/{custom-reason-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name":
    {
    },
  • "usage_context_group": "SALES_PRICE_MODIFICATION",
  • "usage_context":
    {
    },
  • "archetype":
    {
    }
}

Update a custom reason

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

custom-reason-id
required
string

ID of the custom reason to act upon

Request Body schema: application/json
name
required
object (LocalizedString)

Holds a text that is optionally localized to different languages.

Responses

200

Custom reason was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

patch/org/{org-id}/custom-reasons/{custom-reason-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/custom-reasons/{custom-reason-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name":
    {
    },
  • "usage_context_group": "SALES_PRICE_MODIFICATION",
  • "usage_context":
    {
    },
  • "archetype":
    {
    }
}

Bank Accounts

Load the bank accounts in the organization

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

Responses

200

Bank accounts are successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/bank-accounts

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/bank-accounts

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Creates a new bank account in the organization

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

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

The unique bank account name.

iban
required
string [ 5 .. 34 ] characters

The International Bank Account Number.

bic
string [ 8 .. 11 ] characters

The Business Identifier Codes BIC also known as SWIFT-Code

owner
string [ 1 .. 256 ] characters

The bank account owner

Responses

201

Bank account has been successfully created

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

post/org/{org-id}/bank-accounts

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/bank-accounts

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "iban": "string",
  • "bic": "stringst",
  • "owner": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "iban": "string",
  • "bic": "stringst",
  • "owner": "string"
}

Brands

List brands sorted by name.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

Responses

200

List of brands

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/brands

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/brands

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Create a new Brand

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
name
required
string

The name of the brand.

Note that this isn't part of the corporate identity but only used to identify the brand within the organization. For example, when selecting the brand for a marketing campaign.

description
string

A short description of the brand.

Note that this isn't part of the corporate identity but only used to identify the brand within the organization. For example, when selecting the brand for a marketing campaign.

belongs_to
required
any (ContactRef)
business_information
required
object (BrandBusinessInformation)

Holds information about the business for a brand.

contact_information
required
object (BrandContactInformation)

Holds contact information for a brand.

Note that all contact details here must be referenced from the brand's "belongs_to" contact.

social_media_links
Array of strings

Social media links for the brand.

This is a list of WebAddress IDs.

Note that all web addresses here must be referenced from the brand's "belongsTo" contact.

brand_colors
object (BrandColors)

Holds color information for a brand.

All colors must be specified as hexadecimal RGBA values in the form "#RRGGBBAA".

Also see https://www.w3.org/TR/css-color-4/#hex-notation

email_boilerplate_info_text
string

The text used a "info text" in all email boilerplate.

Supports limited Markdown (emphasis, strong emphasis, links).

The email boilerplate is the section at the bottom of the email that shows the social media links and business/contact info (e.g., business name, address).

The text specified here is shown in addition to those elements and can be used to communicate additional information or just some marketing slogan.

Responses

200

Created brand

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

post/org/{org-id}/brands

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/brands

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "belongs_to":
    {
    },
  • "business_information":
    {
    },
  • "contact_information":
    {
    },
  • "social_media_links":
    [
    ],
  • "brand_colors":
    {
    },
  • "email_boilerplate_info_text": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "belongs_to":
    {
    },
  • "is_organization_default_brand": true,
  • "business_information":
    {
    },
  • "contact_information":
    {
    },
  • "social_media_links":
    [
    ],
  • "brand_colors":
    {
    },
  • "email_boilerplate_info_text": "string"
}

Remove a brand

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

brand-id
required
string

ID of the brand to act upon

Responses

204

Brand was successfully removed.

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/brands/{brand-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/brands/{brand-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Update a brand

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

brand-id
required
string

ID of the brand to act upon

Request Body schema: application/json
name
required
string
description
string
business_information
required
object (BrandBusinessInformation)

Holds information about the business for a brand.

contact_information
required
object (BrandContactInformation)

Holds contact information for a brand.

Note that all contact details here must be referenced from the brand's "belongs_to" contact.

social_media_links
Array of strings
brand_colors
object (BrandColors)

Holds color information for a brand.

All colors must be specified as hexadecimal RGBA values in the form "#RRGGBBAA".

Also see https://www.w3.org/TR/css-color-4/#hex-notation

email_boilerplate_info_text
string

Responses

200

Updated brand

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

patch/org/{org-id}/brands/{brand-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/brands/{brand-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "description": "string",
  • "business_information":
    {
    },
  • "contact_information":
    {
    },
  • "social_media_links":
    [
    ],
  • "brand_colors":
    {
    },
  • "email_boilerplate_info_text": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "belongs_to":
    {
    },
  • "is_organization_default_brand": true,
  • "business_information":
    {
    },
  • "contact_information":
    {
    },
  • "social_media_links":
    [
    ],
  • "brand_colors":
    {
    },
  • "email_boilerplate_info_text": "string"
}

Business Information

Load the business information of the organization

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Responses

200

The business information of the organization is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/business-information

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/business-information

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "registered_business_name": "string",
  • "legal_entity_type": "SELBSTSTAENDIG",
  • "company_logo_id": "string",
  • "organization_contact_id": "string",
  • "phone_id": "string",
  • "email_id": "string",
  • "address_id": "string",
  • "web_address_id": "string",
  • "owner_id": "string",
  • "tax_information":
    {
    },
  • "supplier_global_location_number": "string",
  • "default_language": "string",
  • "customer_document_information":
    {
    }
}

Partial update of the business information

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
@type
required
string
Default: "BusinessInformationPhoneUpdate"
BusinessInformationPhoneUpdate
phone_id
string [ 1 .. 256 ] characters

Responses

200

Business information was successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

patch/org/{org-id}/business-information

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/business-information

Request samples

Content type
application/json
Example
BusinessInformationPhoneUpdate
Copy
 Expand all Collapse all
{
  • "@type": "BusinessInformationPhoneUpdate",
  • "phone_id": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "registered_business_name": "string",
  • "legal_entity_type": "SELBSTSTAENDIG",
  • "company_logo_id": "string",
  • "organization_contact_id": "string",
  • "phone_id": "string",
  • "email_id": "string",
  • "address_id": "string",
  • "web_address_id": "string",
  • "owner_id": "string",
  • "tax_information":
    {
    },
  • "supplier_global_location_number": "string",
  • "default_language": "string",
  • "customer_document_information":
    {
    }
}

Group Values

List group values sorted by name.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

Responses

200

List of group values

get/org/{org-id}/group-values

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/group-values

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Create a new group value

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
icon
string

The identifier of the icon to use for visualizing the group value.

name
required
string

The name to use for visualizing the group value.

description
string

A description of the group value.

Responses

200

Created group value

post/org/{org-id}/group-values

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/group-values

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "icon": "string",
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "icon": "string",
  • "name": "string",
  • "description": "string"
}

Update a group value

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

group-value-id
required
string

ID of the group value to act upon

Request Body schema: application/json
icon
string

The identifier of the icon to use for visualizing the group value.

name
required
string

The name to use for visualizing the group value.

description
string

A description of the group value.

Responses

200

Updated group value

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

put/org/{org-id}/group-values/{group-value-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/group-values/{group-value-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "icon": "string",
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "icon": "string",
  • "name": "string",
  • "description": "string"
}

Remove a group value

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

group-value-id
required
string

ID of the group value to act upon

Responses

204

Group value was successfully removed.

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/group-values/{group-value-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/group-values/{group-value-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Assortment Tags

List assortment tags sorted by name.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

Responses

200

List of assortment tags

get/org/{org-id}/assortment-tags

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/assortment-tags

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Create a new assortment tag

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
icon
string

The identifier of the icon to use for visualizing the assortment tag.

name
required
object (LocalizedString)

Holds a text that is optionally localized to different languages.

description
object (LocalizedString)

Holds a text that is optionally localized to different languages.

Responses

200

Created assortment tag

post/org/{org-id}/assortment-tags

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/assortment-tags

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "icon": "string",
  • "name":
    {
    },
  • "description":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "icon": "string",
  • "name":
    {
    },
  • "description":
    {
    }
}

Load an assortment tag

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

assortment-tag-id
required
string

ID of the assortment tag to act upon

Responses

200

The assortment tag

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/assortment-tags/{assortment-tag-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/assortment-tags/{assortment-tag-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "icon": "string",
  • "name":
    {
    },
  • "description":
    {
    }
}

Update an assortment tag

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

assortment-tag-id
required
string

ID of the assortment tag to act upon

Request Body schema: application/json
icon
string

The identifier of the icon to use for visualizing the assortment tag.

name
required
object (LocalizedString)

Holds a text that is optionally localized to different languages.

description
object (LocalizedString)

Holds a text that is optionally localized to different languages.

Responses

200

Updated assortment tag

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

put/org/{org-id}/assortment-tags/{assortment-tag-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/assortment-tags/{assortment-tag-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "icon": "string",
  • "name":
    {
    },
  • "description":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "icon": "string",
  • "name":
    {
    },
  • "description":
    {
    }
}

Remove an assortment tag

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

assortment-tag-id
required
string

ID of the assortment tag to act upon

Responses

204

Assortment tag was successfully removed.

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/assortment-tags/{assortment-tag-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/assortment-tags/{assortment-tag-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Load the organization's assortment tag settings

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Responses

200

Updated assortment tag

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/assortment-tag-settings

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/assortment-tag-settings

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "use_assortment_tags": false
}

Update the organization's assortment tag settings

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
use_assortment_tags
required
boolean
Default: false

Configuration flag that controls whether the organization uses assortment tags or not.

When TRUE, the organization makes use of assortment tags to model the listing of products on sales channels. The ProductSalesChannelInformation objects are only needed to hold channel-specific product settings such as channel-specific prices.

When FALSE, the organization uses the "old way" of listing products on sales channels by manual creation of the ProductSalesChannelInformation objects via the ERP-API or enforePOS client.

Note that assortment tags can be created and assigned to products and sales channels, even when the setting is FALSE. The assigned tags simply do not have any effect.

Responses

200

Updated assortment tag

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

put/org/{org-id}/assortment-tag-settings

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/assortment-tag-settings

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "use_assortment_tags": false
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "use_assortment_tags": false
}

Storage Tags

List storage tags sorted by name.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

Responses

200

List of storage tags

get/org/{org-id}/storage-tags

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/storage-tags

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Create a new storage tag

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
icon
string

The identifier of the icon to use for visualizing the storage tag.

name
required
object (LocalizedString)

Holds a text that is optionally localized to different languages.

description
object (LocalizedString)

Holds a text that is optionally localized to different languages.

Responses

200

Created storage tag

post/org/{org-id}/storage-tags

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/storage-tags

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "icon": "string",
  • "name":
    {
    },
  • "description":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "icon": "string",
  • "name":
    {
    },
  • "description":
    {
    }
}

Update a storage tag

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

storage-tag-id
required
string

ID of the storage tag to act upon

Request Body schema: application/json
icon
string

The identifier of the icon to use for visualizing the storage tag.

name
required
object (LocalizedString)

Holds a text that is optionally localized to different languages.

description
object (LocalizedString)

Holds a text that is optionally localized to different languages.

Responses

200

Updated storage tag

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

put/org/{org-id}/storage-tags/{storage-tag-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/storage-tags/{storage-tag-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "icon": "string",
  • "name":
    {
    },
  • "description":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "icon": "string",
  • "name":
    {
    },
  • "description":
    {
    }
}

Remove a storage tag

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

storage-tag-id
required
string

ID of the storage tag to act upon

Responses

204

Storage tag was successfully removed.

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/storage-tags/{storage-tag-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/storage-tags/{storage-tag-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Inventory Management Tags

List inventory management tags sorted by name.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

Responses

200

Tags returned

403

Credentials missing or not sufficient

get/org/{org-id}/inventory-management-tags

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/inventory-management-tags

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Create a new inventory management tag

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
icon
string

The identifier of the icon to use for visualizing the inventory management tag.

name
required
object (LocalizedString)

Holds a text that is optionally localized to different languages.

description
object (LocalizedString)

Holds a text that is optionally localized to different languages.

Responses

200

Tag created

403

Credentials missing or not sufficient

422

Specified data is semantically incorrect.

post/org/{org-id}/inventory-management-tags

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/inventory-management-tags

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "icon": "string",
  • "name":
    {
    },
  • "description":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "icon": "string",
  • "name":
    {
    },
  • "description":
    {
    }
}

Update an inventory management tag

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

inventory-management-tag-id
required
string

ID of the inventory management tag to act upon

Request Body schema: application/json
icon
string

The identifier of the icon to use for visualizing the inventory management tag.

name
required
object (LocalizedString)

Holds a text that is optionally localized to different languages.

description
object (LocalizedString)

Holds a text that is optionally localized to different languages.

Responses

200

Tag updated

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

put/org/{org-id}/inventory-management-tags/{inventory-management-tag-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/inventory-management-tags/{inventory-management-tag-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "icon": "string",
  • "name":
    {
    },
  • "description":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "icon": "string",
  • "name":
    {
    },
  • "description":
    {
    }
}

Remove an inventory management tag

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

inventory-management-tag-id
required
string

ID of the inventory management tag to act upon

Responses

204

Tag removed

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/inventory-management-tags/{inventory-management-tag-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/inventory-management-tags/{inventory-management-tag-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Images

Create a new V1 image.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
data
required
string

The base64 encoded image binary

Responses

200

Successfully uploaded the image

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

post/org/{org-id}/images/v1

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/images/v1

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string"
}

Create a new V2 image.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
data
required
string

The base64 encoded image binary

Responses

200

Successfully uploaded the image

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

post/org/{org-id}/images/v2

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/images/v2

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "source_data":
    {
    }
}

Get information about a V2 image.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

image-id
required
string

ID of the image to act upon

Responses

200

Information successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/images/v2/{image-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/images/v2/{image-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "source_data":
    {
    }
}

Event Log

Iterate over entries in the event log

Returns event log entries, sorted in ascending order by their persisted_on timestamp.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
from
required
string <date-time>

Defines the time starting from which objects are to be returned.

This time must be at most 3 months in the past.

Objects with exactly this date are also returned - this means that the start of a left-closed interval is defined.

Timestamp in UTC. The date-time notation as defined by RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt), section 5.6, with the "Z" as time-offset. For example, 2017-07-21T17:32:28.123Z

to
required
string <date-time>

Defines the time up to which objects are to be returned. Objects with exactly this date are not returned - this means that the end of a right-open interval is defined. Timestamp in UTC. The date-time notation as defined by RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt), section 5.6, with the "Z" as time-offset. For example, 2017-07-21T17:32:28.123Z

limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> [ 0 .. 10000 ]

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

service_location_id
string

When specified, only event log entries that occurred at the specified service location are returned.

device_id
string

When specified, only event log entries that occurred on the specified device are returned.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/event-log/entries

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/event-log/entries

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Load event log settings

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Responses

200

Current settings are successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/event-log/settings

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/event-log/settings

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "event_log_enabled": true
}

Set event log settings

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
event_log_enabled
required
boolean

Flag that controls whether the event log is enabled or not.

Note that changing the flag will not immediately cause all entities that can record events to become aware of the change.

For example, client runtimes only check for changes to the flag on startup, when preparing offline data, and about every six hours.

Responses

200

Settings were successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

put/org/{org-id}/event-log/settings

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/event-log/settings

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "event_log_enabled": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "event_log_enabled": true
}

Create a subscription Deprecated

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
callback_url
required
string <uri>

The callback URL where event notifications are to be delivered. It must be HTTPS to prevent man-in-the-middle attacks.

Responses

201

Registration of subscription successful (or already subscribed)

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

Callbacks

post<no summary>
post/org/{org-id}/event-log/subscriptions

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/event-log/subscriptions

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Callback payload samples

Callback
POST: <no summary>
Content type
application/json
Copy
 Expand all Collapse all
{
  • "org_id": "string",
  • "items":
    [
    ],
  • "problems":
    []
}

Delete a subscription Deprecated

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

subscription-id
required
string

ID of the subscription to delete

Responses

204

Subscription was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/event-log/subscriptions/{subscription-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/event-log/subscriptions/{subscription-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Delete a subscription

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

subscription-id
required
string

ID of the subscription to delete

Responses

204

Subscription was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/event-log-subscriptions/{subscription-id}

Production

https://external-prod2.apis.enfore.com/orgstructure/org/{org-id}/event-log-subscriptions/{subscription-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}