Download OpenAPI specification:Download
enfore API for managing sales and purchasing
Returns procurements, sorted in ascending order by creation order date and time.
org-id required | string ID of the organization whose data is being accessed. |
from required | string <date-time> Defines the time starting from which objects are to be returned. 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 |
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 |
number | string When specified, only procurements with the specified number are returned. |
Data successfully returned
Invalid parameters were sent by the client
Credentials missing or not sufficient
Production
{- "items": [
- {
- "id": "string",
- "number": "string",
- "number_issued_by_supplier": "string",
- "supplier_id": {
- "id": "string"
}, - "issue_date": "2025-03-25T16:20:14Z",
- "procurement_for": [
- "string"
], - "deliveries": [
- "string"
], - "invoice_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "delivery_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "creator_staff_id": "string",
- "responsible_staff_id": "string",
- "note": "string",
- "status": "ISSUED",
- "cancelation_info": {
- "reason": "REJECTED_BY_SUPPLIER",
- "canceled_on": "2025-03-25T16:20:14Z",
- "note": "string"
}
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}
org-id required | string ID of the organization whose data is being accessed. |
goods-procurement-id required | string ID of the goods procurement |
GoodsProcurement is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "id": "string",
- "number": "string",
- "number_issued_by_supplier": "string",
- "supplier_id": {
- "id": "string"
}, - "issue_date": "2025-03-25T16:20:15Z",
- "procurement_for": [
- "string"
], - "deliveries": [
- "string"
], - "invoice_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "delivery_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "creator_staff_id": "string",
- "responsible_staff_id": "string",
- "note": "string",
- "status": "ISSUED",
- "cancelation_info": {
- "reason": "REJECTED_BY_SUPPLIER",
- "canceled_on": "2025-03-25T16:20:15Z",
- "note": "string"
}
}
org-id required | string ID of the organization whose data is being accessed. |
goods-procurement-id required | string ID of the goods procurement |
number_issued_by_supplier | string [ 1 .. 256 ] characters A "number" identifier that the supplier uses in communications to identify this GoodsProcurement. |
status | string (GoodsProcurementStatusType) Enum: "ISSUED" "RECEIVED" "CONFIRMED" "IN_PROCESS" "COMPLETED" "CANCELED" |
cancelation_info | object (GoodsProcurementCancelationInfo) The reason why GoodsProcurement was canceled. |
GoodsProcurement is successfully updated.
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "number_issued_by_supplier": "string",
- "status": "ISSUED",
- "cancelation_info": {
- "reason": "REJECTED_BY_SUPPLIER",
- "canceled_on": "2025-03-25T16:20:15Z",
- "note": "string"
}
}
{- "id": "string",
- "number": "string",
- "number_issued_by_supplier": "string",
- "supplier_id": {
- "id": "string"
}, - "issue_date": "2025-03-25T16:20:15Z",
- "procurement_for": [
- "string"
], - "deliveries": [
- "string"
], - "invoice_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "delivery_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "creator_staff_id": "string",
- "responsible_staff_id": "string",
- "note": "string",
- "status": "ISSUED",
- "cancelation_info": {
- "reason": "REJECTED_BY_SUPPLIER",
- "canceled_on": "2025-03-25T16:20:15Z",
- "note": "string"
}
}
Returns items of the specified goods procurement, sorted in ascending order by creation order date and time.
org-id required | string ID of the organization whose data is being accessed. |
goods-procurement-id required | string ID of the goods procurement |
Data successfully returned
Invalid parameters were sent by the client
Credentials missing or not sufficient
Production
{- "items": [
- {
- "id": "string",
- "external_number": "string",
- "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "product_id": "string",
- "note": "string",
- "received_quantity": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "failed_quantity": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "sort_value": "",
- "group_value": {
- "value_type": "GROUP_VALUE",
- "value_id": "string"
}
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}
Retrieve all currently active event subscriptions.
org-id required | string ID of the organization whose data is being accessed. |
List of registrations
Credentials missing or not sufficient
Production
{- "items": [
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}
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.
org-id required | string ID of the organization whose data is being accessed. |
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. |
Registration of subscription successful (or already subscribed)
Invalid parameters were sent by the client
Credentials missing or not sufficient
Production
{
}
{- "id": "string",
- "public_key": "string"
}
{- "org_id": "string",
- "items": [
- {
- "number_issued_by_supplier": "string",
- "supplier_id": {
- "id": "string"
}, - "issue_date": "2025-03-25T16:20:15Z",
- "procurement_for": [
- "string"
], - "deliveries": [
- "string"
], - "invoice_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "delivery_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "creator_staff_id": "string",
- "responsible_staff_id": "string",
- "note": "string",
- "status": "ISSUED",
- "cancelation_info": {
- "reason": "REJECTED_BY_SUPPLIER",
- "canceled_on": "2025-03-25T16:20:15Z",
- "note": "string"
}
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}
org-id required | string ID of the organization whose data is being accessed. |
subscription-id required | string ID of the subscription to delete |
Subscription was successfully deleted
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "title": "string",
- "detail": "string",
}
Returns fulfillment sales order drafts, sorted in ascending order by creation order date and time.
org-id required | string ID of the organization whose data is being accessed. |
from required | string <date-time> Defines the time starting from which objects are to be returned. 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 |
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 |
sales_channel_id | string When specified, only fulfillment sales order drafts for the specified sales channel are returned. |
number | string When specified, only fulfillment sales order drafts with the specified number are returned. |
Data successfully returned
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "items": [
- {
- "id": "string",
- "number": "string",
- "sales_channel_id": "string",
- "invoice_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "description": "string",
- "note": "string"
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}
org-id required | string ID of the organization whose data is being accessed. |
sales_channel_id required | string [ 1 .. 256 ] characters The ID of the sales channel that the order belongs to. |
invoice_address | object (Address) An address of a location/destination |
description | string A short description given to the order by a user (e.g., cashier) for the pupose of identifying it later on (e.g., in the order switcher). |
note | string A human readable "note" text that will be displayed in the UI and on business documents. |
Fulfillment sales order draft is successfully created.
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "sales_channel_id": "string",
- "invoice_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "description": "string",
- "note": "string"
}
{- "id": "string",
- "number": "string",
- "sales_channel_id": "string",
- "invoice_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "description": "string",
- "note": "string"
}
org-id required | string ID of the organization whose data is being accessed. |
fso-draft-id required | string ID of the fulfillment sales order draft |
Fulfillment sales order draft is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "id": "string",
- "number": "string",
- "sales_channel_id": "string",
- "invoice_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "description": "string",
- "note": "string"
}
org-id required | string ID of the organization whose data is being accessed. |
fso-draft-id required | string ID of the fulfillment sales order draft |
sales_channel_id required | string [ 1 .. 256 ] characters The ID of the sales channel that the order belongs to. |
invoice_address | object (Address) An address of a location/destination |
description | string A short description given to the order by a user (e.g., cashier) for the pupose of identifying it later on (e.g., in the order switcher). |
note | string A human readable "note" text that will be displayed in the UI and on business documents. |
Fulfillment sales order draft is successfully updated.
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "sales_channel_id": "string",
- "invoice_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "description": "string",
- "note": "string"
}
{- "id": "string",
- "number": "string",
- "sales_channel_id": "string",
- "invoice_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "description": "string",
- "note": "string"
}
org-id required | string ID of the organization whose data is being accessed. |
fso-draft-id required | string ID of the fulfillment sales order draft |
Fulfillment sales order draft info was successfully deleted.
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "title": "string",
- "detail": "string",
}
org-id required | string ID of the organization whose data is being accessed. |
@type required | string Value: "FulfillmentSalesOrderDraftWithSubresources" |
draft required | object (FulfillmentSalesOrderDraft) |
items | Array of objects (FulfillmentSalesOrderDraftItem) |
customer_information | any (ContactInformation) Information about a contact. Depending on the type of contact (private person, organization, organization with representative) and whether the entities are modeled as contacts via the contacts API, different structures are used. Note that this structure is used to reference plain contacts as well as contacts with a specific role such as customer or suppliers. Depending on the usage context, not all types of contact informations may be usable. |
fulfillment_information | Array of any (FulfillmentInformation) |
Fulfillment sales order draft is successfully created.
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "@type": "FulfillmentSalesOrderDraftWithSubresources",
- "draft": {
- "sales_channel_id": "string",
- "invoice_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "description": "string",
- "note": "string"
}, - "items": [
- {
- "id": "string",
- "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "lot_id": "string",
- "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}, - "options": [
- {
- "option_definition": {
- "option_group_id": "string",
- "option_id": "string"
}, - "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "is_single_issue": true,
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}
}
], - "extra_charges": [
- {
- "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "is_single_issue": true,
- "extra_charge_type": "DEPOSIT",
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}
}
], - "fulfillment_information": [
- {
- "fulfillment_information_id": "string",
- "number_of_units": 0
}
], - "barcode": {
- "barcode_format": "UNKNOWN",
- "raw_value": "string",
- "code_value": "string",
- "parsed_data": {
- "@type": "GS1VariableMeasurePrice",
- "country": "AF",
- "prefix": "string",
- "identifier": "string",
- "price": {
- "value": 0,
- "unit": "AUD"
}
}
}
}
], - "customer_information": {
- "@type": "AnonymousContactInformation",
- "name": "string",
- "contact_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "contact_email": "user@example.com",
- "contact_phone": "string",
- "unique_instance_id": "string",
- "external_data": "string",
- "user_level_identifiers": [
- {
- "identifier": "string",
- "label": "string"
}
]
}, - "fulfillment_information": [
- {
- "@type": "PickupFulfillmentInformation",
- "fulfillment_location_id": "string",
- "fulfillment_processing_location_id": "string",
- "scheduled_pickup_time": {
- "start": "2025-03-25T16:20:15Z",
- "end": "2025-03-25T16:20:15Z"
}, - "collector": {
- "@type": "AnonymousContactInformation",
- "name": "string",
- "contact_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "contact_email": "user@example.com",
- "contact_phone": "string",
- "unique_instance_id": "string",
- "external_data": "string",
- "user_level_identifiers": [
- {
- "identifier": "string",
- "label": "string"
}
]
}, - "pager_id": "string"
}
]
}
{- "id": "string",
- "number": "string",
- "sales_channel_id": "string",
- "invoice_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "description": "string",
- "note": "string"
}
org-id required | string ID of the organization whose data is being accessed. |
fso-draft-id required | string ID of the fulfillment sales order draft |
Customer info is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "@type": "AnonymousContactInformation",
- "name": "string",
- "contact_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "contact_email": "user@example.com",
- "contact_phone": "string",
- "unique_instance_id": "string",
- "external_data": "string",
- "user_level_identifiers": [
- {
- "identifier": "string",
- "label": "string"
}
]
}
org-id required | string ID of the organization whose data is being accessed. |
fso-draft-id required | string ID of the fulfillment sales order draft |
@type required | string Default: "AnonymousContactInformation" AnonymousContactInformation |
name | string The name of the contact. |
contact_address | object (Address) An address of a location/destination |
contact_email | string <email> |
contact_phone | string <phone> |
unique_instance_id | string <= 256 characters An optional identifier that can be present on a contact reference that was created by an external system (e.g., via API or ProvideContact-CUWO). |
external_data | string <= 256 characters Optional external data that can be present on a contact reference that was created by an external system (e.g., via API or ProvideContact-CUWO). |
user_level_identifiers | Array of objects (LabeledIdentifier) A list of identifiers of the contact that should be shown to the user given the context the contact is used in. |
Customer info is successfully updated.
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "@type": "AnonymousContactInformation",
- "name": "string",
- "contact_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "contact_email": "user@example.com",
- "contact_phone": "string",
- "unique_instance_id": "string",
- "external_data": "string",
- "user_level_identifiers": [
- {
- "identifier": "string",
- "label": "string"
}
]
}
{- "@type": "AnonymousContactInformation",
- "name": "string",
- "contact_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "contact_email": "user@example.com",
- "contact_phone": "string",
- "unique_instance_id": "string",
- "external_data": "string",
- "user_level_identifiers": [
- {
- "identifier": "string",
- "label": "string"
}
]
}
org-id required | string ID of the organization whose data is being accessed. |
fso-draft-id required | string ID of the fulfillment sales order draft |
Customer info was successfully deleted.
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "title": "string",
- "detail": "string",
}
org-id required | string ID of the organization whose data is being accessed. |
fso-draft-id required | string ID of the fulfillment sales order draft |
List is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "items": [
- {
- "@type": "PickupFulfillmentInformation",
- "id": "string",
- "fulfillment_location_id": "string",
- "fulfillment_processing_location_id": "string",
- "scheduled_pickup_time": {
- "start": "2025-03-25T16:20:16Z",
- "end": "2025-03-25T16:20:16Z"
}, - "collector": {
- "@type": "AnonymousContactInformation",
- "name": "string",
- "contact_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "contact_email": "user@example.com",
- "contact_phone": "string",
- "unique_instance_id": "string",
- "external_data": "string",
- "user_level_identifiers": [
- {
- "identifier": "string",
- "label": "string"
}
]
}, - "pager_id": "string",
- "pickup_code": "string"
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}
org-id required | string ID of the organization whose data is being accessed. |
fso-draft-id required | string ID of the fulfillment sales order draft |
@type required | string PickupFulfillmentInformation |
fulfillment_location_id required | string [ 1 .. 256 ] characters The ID of the ServiceLocation where the fulfillment is performed. Fulfillment of orders is always carried out at a ServiceLocation (branch) of an organisation. This is not necessarily the ServiceLocation where the order has been placed. |
fulfillment_processing_location_id required | string [ 1 .. 256 ] characters The ID of the ProcessingLocation where the fulfillment is performed. |
scheduled_pickup_time | object (TimeRange) |
collector | any (ContactInformation) Information about a contact. Depending on the type of contact (private person, organization, organization with representative) and whether the entities are modeled as contacts via the contacts API, different structures are used. Note that this structure is used to reference plain contacts as well as contacts with a specific role such as customer or suppliers. Depending on the usage context, not all types of contact informations may be usable. |
pager_id | string For pickups with notification by pager the ID to be used. |
Fulfillment info is successfully created.
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "@type": "PickupFulfillmentInformation",
- "fulfillment_location_id": "string",
- "fulfillment_processing_location_id": "string",
- "scheduled_pickup_time": {
- "start": "2025-03-25T16:20:16Z",
- "end": "2025-03-25T16:20:16Z"
}, - "collector": {
- "@type": "AnonymousContactInformation",
- "name": "string",
- "contact_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "contact_email": "user@example.com",
- "contact_phone": "string",
- "unique_instance_id": "string",
- "external_data": "string",
- "user_level_identifiers": [
- {
- "identifier": "string",
- "label": "string"
}
]
}, - "pager_id": "string"
}
{- "@type": "PickupFulfillmentInformation",
- "id": "string",
- "fulfillment_location_id": "string",
- "fulfillment_processing_location_id": "string",
- "scheduled_pickup_time": {
- "start": "2025-03-25T16:20:16Z",
- "end": "2025-03-25T16:20:16Z"
}, - "collector": {
- "@type": "AnonymousContactInformation",
- "name": "string",
- "contact_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "contact_email": "user@example.com",
- "contact_phone": "string",
- "unique_instance_id": "string",
- "external_data": "string",
- "user_level_identifiers": [
- {
- "identifier": "string",
- "label": "string"
}
]
}, - "pager_id": "string",
- "pickup_code": "string"
}
org-id required | string ID of the organization whose data is being accessed. |
fso-draft-id required | string ID of the fulfillment sales order draft |
fulfillment-id required | string ID of the fulfillment info |
Fulfillment info is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "@type": "PickupFulfillmentInformation",
- "id": "string",
- "fulfillment_location_id": "string",
- "fulfillment_processing_location_id": "string",
- "scheduled_pickup_time": {
- "start": "2025-03-25T16:20:16Z",
- "end": "2025-03-25T16:20:16Z"
}, - "collector": {
- "@type": "AnonymousContactInformation",
- "name": "string",
- "contact_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "contact_email": "user@example.com",
- "contact_phone": "string",
- "unique_instance_id": "string",
- "external_data": "string",
- "user_level_identifiers": [
- {
- "identifier": "string",
- "label": "string"
}
]
}, - "pager_id": "string",
- "pickup_code": "string"
}
org-id required | string ID of the organization whose data is being accessed. |
fso-draft-id required | string ID of the fulfillment sales order draft |
fulfillment-id required | string ID of the fulfillment info |
@type required | string PickupFulfillmentInformation |
fulfillment_location_id required | string [ 1 .. 256 ] characters The ID of the ServiceLocation where the fulfillment is performed. Fulfillment of orders is always carried out at a ServiceLocation (branch) of an organisation. This is not necessarily the ServiceLocation where the order has been placed. |
fulfillment_processing_location_id required | string [ 1 .. 256 ] characters The ID of the ProcessingLocation where the fulfillment is performed. |
scheduled_pickup_time | object (TimeRange) |
collector | any (ContactInformation) Information about a contact. Depending on the type of contact (private person, organization, organization with representative) and whether the entities are modeled as contacts via the contacts API, different structures are used. Note that this structure is used to reference plain contacts as well as contacts with a specific role such as customer or suppliers. Depending on the usage context, not all types of contact informations may be usable. |
pager_id | string For pickups with notification by pager the ID to be used. |
Fulfillment info is successfully updated.
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "@type": "PickupFulfillmentInformation",
- "fulfillment_location_id": "string",
- "fulfillment_processing_location_id": "string",
- "scheduled_pickup_time": {
- "start": "2025-03-25T16:20:16Z",
- "end": "2025-03-25T16:20:16Z"
}, - "collector": {
- "@type": "AnonymousContactInformation",
- "name": "string",
- "contact_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "contact_email": "user@example.com",
- "contact_phone": "string",
- "unique_instance_id": "string",
- "external_data": "string",
- "user_level_identifiers": [
- {
- "identifier": "string",
- "label": "string"
}
]
}, - "pager_id": "string"
}
{- "@type": "PickupFulfillmentInformation",
- "id": "string",
- "fulfillment_location_id": "string",
- "fulfillment_processing_location_id": "string",
- "scheduled_pickup_time": {
- "start": "2025-03-25T16:20:16Z",
- "end": "2025-03-25T16:20:16Z"
}, - "collector": {
- "@type": "AnonymousContactInformation",
- "name": "string",
- "contact_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "contact_email": "user@example.com",
- "contact_phone": "string",
- "unique_instance_id": "string",
- "external_data": "string",
- "user_level_identifiers": [
- {
- "identifier": "string",
- "label": "string"
}
]
}, - "pager_id": "string",
- "pickup_code": "string"
}
org-id required | string ID of the organization whose data is being accessed. |
fso-draft-id required | string ID of the fulfillment sales order draft |
fulfillment-id required | string ID of the fulfillment info |
Fulfillment info was successfully deleted.
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "title": "string",
- "detail": "string",
}
Returns items of the specified fulfillment sales order draft, sorted in ascending order by creation order date and time.
org-id required | string ID of the organization whose data is being accessed. |
fso-draft-id required | string ID of the fulfillment sales order draft |
limit | integer <int64> [ 1 .. 5000 ] Max number of objects to be returned per page.
Note that both the |
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 |
Data successfully returned
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "items": [
- {
- "id": "string",
- "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "lot_id": "string",
- "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}, - "options": [
- {
- "id": "string",
- "option_definition": {
- "option_group_id": "string",
- "option_id": "string"
}, - "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "is_single_issue": true,
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}
}
], - "extra_charges": [
- {
- "id": "string",
- "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "is_single_issue": true,
- "extra_charge_type": "DEPOSIT",
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}
}
], - "fulfillment_information": [
- {
- "fulfillment_information_id": "string",
- "number_of_units": 0
}
], - "barcode": {
- "barcode_format": "UNKNOWN",
- "raw_value": "string",
- "code_value": "string",
- "parsed_data": {
- "@type": "GS1VariableMeasurePrice",
- "country": "AF",
- "prefix": "string",
- "identifier": "string",
- "price": {
- "value": 0,
- "unit": "AUD"
}
}
}
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}
org-id required | string ID of the organization whose data is being accessed. |
fso-draft-id required | string ID of the fulfillment sales order draft |
id | string [ 1 .. 256 ] characters The technical identifier of the object. Assigned by the enfore platform on creation of the object and not changeable afterwards. |
product required | object (ProductReference) |
lot_id | string [ 1 .. 256 ] characters The ID of the lot from which the sold units are taken. |
unit required | object (Quantity) A Quantity represents a quantity value (i.e., a unit and an amount), for example "3 pcs" or "2.5 kg". |
number_of_units required | integer <int64> The number of units as specified by "unit". |
pricing_configuration | object (LineItemPricingConfiguration) |
options | Array of objects (SalesOrderItemOption) The options configured for the line item. Only used when the product is a BTO product with options. |
extra_charges | Array of objects (SalesOrderItemExtraCharge) The extra charges configured for the line item. |
fulfillment_information | Array of objects (SalesOrderItemFulfillmentInformation) Array of SalesOrderItemFulfillmentInformation structures that define what number of units of this line item are part of which fulfillment. |
barcode | object (Barcode) Data structure holding information about a barcode. |
Item is successfully created.
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "id": "string",
- "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "lot_id": "string",
- "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}, - "options": [
- {
- "option_definition": {
- "option_group_id": "string",
- "option_id": "string"
}, - "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "is_single_issue": true,
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}
}
], - "extra_charges": [
- {
- "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "is_single_issue": true,
- "extra_charge_type": "DEPOSIT",
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}
}
], - "fulfillment_information": [
- {
- "fulfillment_information_id": "string",
- "number_of_units": 0
}
], - "barcode": {
- "barcode_format": "UNKNOWN",
- "raw_value": "string",
- "code_value": "string",
- "parsed_data": {
- "@type": "GS1VariableMeasurePrice",
- "country": "AF",
- "prefix": "string",
- "identifier": "string",
- "price": {
- "value": 0,
- "unit": "AUD"
}
}
}
}
{- "id": "string",
- "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "lot_id": "string",
- "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}, - "options": [
- {
- "id": "string",
- "option_definition": {
- "option_group_id": "string",
- "option_id": "string"
}, - "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "is_single_issue": true,
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}
}
], - "extra_charges": [
- {
- "id": "string",
- "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "is_single_issue": true,
- "extra_charge_type": "DEPOSIT",
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}
}
], - "fulfillment_information": [
- {
- "fulfillment_information_id": "string",
- "number_of_units": 0
}
], - "barcode": {
- "barcode_format": "UNKNOWN",
- "raw_value": "string",
- "code_value": "string",
- "parsed_data": {
- "@type": "GS1VariableMeasurePrice",
- "country": "AF",
- "prefix": "string",
- "identifier": "string",
- "price": {
- "value": 0,
- "unit": "AUD"
}
}
}
}
org-id required | string ID of the organization whose data is being accessed. |
fso-draft-id required | string ID of the fulfillment sales order draft |
item-id required | string ID of the fulfillment sales order draft item |
Item is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "id": "string",
- "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "lot_id": "string",
- "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}, - "options": [
- {
- "id": "string",
- "option_definition": {
- "option_group_id": "string",
- "option_id": "string"
}, - "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "is_single_issue": true,
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}
}
], - "extra_charges": [
- {
- "id": "string",
- "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "is_single_issue": true,
- "extra_charge_type": "DEPOSIT",
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}
}
], - "fulfillment_information": [
- {
- "fulfillment_information_id": "string",
- "number_of_units": 0
}
], - "barcode": {
- "barcode_format": "UNKNOWN",
- "raw_value": "string",
- "code_value": "string",
- "parsed_data": {
- "@type": "GS1VariableMeasurePrice",
- "country": "AF",
- "prefix": "string",
- "identifier": "string",
- "price": {
- "value": 0,
- "unit": "AUD"
}
}
}
}
org-id required | string ID of the organization whose data is being accessed. |
fso-draft-id required | string ID of the fulfillment sales order draft |
item-id required | string ID of the fulfillment sales order draft item |
id | string [ 1 .. 256 ] characters The technical identifier of the object. Assigned by the enfore platform on creation of the object and not changeable afterwards. |
product required | object (ProductReference) |
lot_id | string [ 1 .. 256 ] characters The ID of the lot from which the sold units are taken. |
unit required | object (Quantity) A Quantity represents a quantity value (i.e., a unit and an amount), for example "3 pcs" or "2.5 kg". |
number_of_units required | integer <int64> The number of units as specified by "unit". |
pricing_configuration | object (LineItemPricingConfiguration) |
options | Array of objects (SalesOrderItemOption) The options configured for the line item. Only used when the product is a BTO product with options. |
extra_charges | Array of objects (SalesOrderItemExtraCharge) The extra charges configured for the line item. |
fulfillment_information | Array of objects (SalesOrderItemFulfillmentInformation) Array of SalesOrderItemFulfillmentInformation structures that define what number of units of this line item are part of which fulfillment. |
barcode | object (Barcode) Data structure holding information about a barcode. |
Item is successfully updated.
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "id": "string",
- "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "lot_id": "string",
- "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}, - "options": [
- {
- "option_definition": {
- "option_group_id": "string",
- "option_id": "string"
}, - "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "is_single_issue": true,
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}
}
], - "extra_charges": [
- {
- "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "is_single_issue": true,
- "extra_charge_type": "DEPOSIT",
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}
}
], - "fulfillment_information": [
- {
- "fulfillment_information_id": "string",
- "number_of_units": 0
}
], - "barcode": {
- "barcode_format": "UNKNOWN",
- "raw_value": "string",
- "code_value": "string",
- "parsed_data": {
- "@type": "GS1VariableMeasurePrice",
- "country": "AF",
- "prefix": "string",
- "identifier": "string",
- "price": {
- "value": 0,
- "unit": "AUD"
}
}
}
}
{- "id": "string",
- "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "lot_id": "string",
- "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}, - "options": [
- {
- "id": "string",
- "option_definition": {
- "option_group_id": "string",
- "option_id": "string"
}, - "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "is_single_issue": true,
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}
}
], - "extra_charges": [
- {
- "id": "string",
- "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "is_single_issue": true,
- "extra_charge_type": "DEPOSIT",
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}
}
], - "fulfillment_information": [
- {
- "fulfillment_information_id": "string",
- "number_of_units": 0
}
], - "barcode": {
- "barcode_format": "UNKNOWN",
- "raw_value": "string",
- "code_value": "string",
- "parsed_data": {
- "@type": "GS1VariableMeasurePrice",
- "country": "AF",
- "prefix": "string",
- "identifier": "string",
- "price": {
- "value": 0,
- "unit": "AUD"
}
}
}
}
org-id required | string ID of the organization whose data is being accessed. |
fso-draft-id required | string ID of the fulfillment sales order draft |
item-id required | string ID of the fulfillment sales order draft item |
Item was successfully deleted.
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "title": "string",
- "detail": "string",
}
Returns fulfillment sales orders, sorted in ascending order by creation order date and time.
org-id required | string ID of the organization whose data is being accessed. |
from required | string <date-time> Defines the time starting from which objects are to be returned. 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 |
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 |
sales_channel_id | string When specified, only fulfillment sales orders for the specified sales channel are returned. |
number | string When specified, only fulfillment sales orders with the specified number are returned. |
Data successfully returned
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "items": [
- {
- "id": "string",
- "number": "string",
- "sales_channel_id": "string",
- "invoice_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "description": "string",
- "note": "string",
- "customer_information": {
- "@type": "AnonymousContactInformation",
- "name": "string",
- "contact_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "contact_email": "user@example.com",
- "contact_phone": "string",
- "unique_instance_id": "string",
- "external_data": "string",
- "user_level_identifiers": [
- {
- "identifier": "string",
- "label": "string"
}
]
}, - "fulfillment_information": [
- {
- "@type": "PickupFulfillmentInformation",
- "id": "string",
- "fulfillment_location_id": "string",
- "fulfillment_processing_location_id": "string",
- "scheduled_pickup_time": {
- "start": "2025-03-25T16:20:17Z",
- "end": "2025-03-25T16:20:17Z"
}, - "collector": {
- "@type": "AnonymousContactInformation",
- "name": "string",
- "contact_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "contact_email": "user@example.com",
- "contact_phone": "string",
- "unique_instance_id": "string",
- "external_data": "string",
- "user_level_identifiers": [
- {
- "identifier": "string",
- "label": "string"
}
]
}, - "pager_id": "string",
- "pickup_code": "string"
}
], - "status": "UNCONFIRMED",
- "kpis": {
- "number_of_items": 0,
- "total_gross_amount": {
- "value": 0,
- "unit": "AUD"
}
}, - "cancelation_info": {
- "cancellation_reason": {
- "@type": "PlatformDefinedImmediateSalesOrderCancellationReason",
- "name": "CUSTOMER_CANCEL"
}, - "note": "string",
- "canceled_on": "2025-03-25T16:20:17Z",
- "canceled_by": "string"
}
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}
org-id required | string ID of the organization whose data is being accessed. |
fso-id required | string ID of the fulfillment sales order |
Fulfillment sales order is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "id": "string",
- "number": "string",
- "sales_channel_id": "string",
- "invoice_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "description": "string",
- "note": "string",
- "customer_information": {
- "@type": "AnonymousContactInformation",
- "name": "string",
- "contact_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "contact_email": "user@example.com",
- "contact_phone": "string",
- "unique_instance_id": "string",
- "external_data": "string",
- "user_level_identifiers": [
- {
- "identifier": "string",
- "label": "string"
}
]
}, - "fulfillment_information": [
- {
- "@type": "PickupFulfillmentInformation",
- "id": "string",
- "fulfillment_location_id": "string",
- "fulfillment_processing_location_id": "string",
- "scheduled_pickup_time": {
- "start": "2025-03-25T16:20:17Z",
- "end": "2025-03-25T16:20:17Z"
}, - "collector": {
- "@type": "AnonymousContactInformation",
- "name": "string",
- "contact_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "contact_email": "user@example.com",
- "contact_phone": "string",
- "unique_instance_id": "string",
- "external_data": "string",
- "user_level_identifiers": [
- {
- "identifier": "string",
- "label": "string"
}
]
}, - "pager_id": "string",
- "pickup_code": "string"
}
], - "status": "UNCONFIRMED",
- "kpis": {
- "number_of_items": 0,
- "total_gross_amount": {
- "value": 0,
- "unit": "AUD"
}
}, - "cancelation_info": {
- "cancellation_reason": {
- "@type": "PlatformDefinedImmediateSalesOrderCancellationReason",
- "name": "CUSTOMER_CANCEL"
}, - "note": "string",
- "canceled_on": "2025-03-25T16:20:17Z",
- "canceled_by": "string"
}
}
Returns items of the specified fulfillment sales order, sorted in ascending order by creation order date and time.
org-id required | string ID of the organization whose data is being accessed. |
fso-id required | string ID of the fulfillment sales order |
from required | string <date-time> Defines the time starting from which objects are to be returned. 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 |
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 |
Data successfully returned
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "items": [
- {
- "id": "string",
- "order_date_and_time": "2025-03-25T16:20:17Z",
- "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "lot_id": "string",
- "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}, - "options": [
- {
- "id": "string",
- "option_definition": {
- "option_group_id": "string",
- "option_id": "string"
}, - "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "is_single_issue": true,
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}
}
], - "extra_charges": [
- {
- "id": "string",
- "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "is_single_issue": true,
- "extra_charge_type": "DEPOSIT",
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}
}
], - "fulfillment_information": [
- {
- "fulfillment_information_id": "string",
- "number_of_units": 0
}
], - "scanned_barcode": {
- "barcode_format": "UNKNOWN",
- "raw_value": "string",
- "code_value": "string",
- "parsed_data": {
- "@type": "GS1VariableMeasurePrice",
- "country": "AF",
- "prefix": "string",
- "identifier": "string",
- "price": {
- "value": 0,
- "unit": "AUD"
}
}
}, - "status": "UNCONFIRMED",
- "cancelations": [
- {
- "number_of_canceled_units": 0,
- "cancellation_reason": {
- "@type": "PlatformDefinedImmediateSalesOrderCancellationReason",
- "name": "CUSTOMER_CANCEL"
}, - "due_to_order_cancellation": true,
- "note": "string",
- "canceled_on": "2025-03-25T16:20:17Z",
- "canceled_by": "string",
- "sales_price_at_cancelation": {
- "price": {
- "value": 0,
- "unit": "AUD"
}, - "price_is_gross": true,
- "quantity": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}, - "total_value_of_cancellation": {
- "value": 0,
- "unit": "AUD"
}
}
], - "sort_key": "string"
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}
org-id required | string ID of the organization whose data is being accessed. |
fso-id required | string ID of the fulfillment sales order |
item-id required | string ID of the fulfillment sales order item |
Item is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "id": "string",
- "order_date_and_time": "2025-03-25T16:20:17Z",
- "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "lot_id": "string",
- "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}, - "options": [
- {
- "id": "string",
- "option_definition": {
- "option_group_id": "string",
- "option_id": "string"
}, - "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "is_single_issue": true,
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}
}
], - "extra_charges": [
- {
- "id": "string",
- "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "is_single_issue": true,
- "extra_charge_type": "DEPOSIT",
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}
}
], - "fulfillment_information": [
- {
- "fulfillment_information_id": "string",
- "number_of_units": 0
}
], - "scanned_barcode": {
- "barcode_format": "UNKNOWN",
- "raw_value": "string",
- "code_value": "string",
- "parsed_data": {
- "@type": "GS1VariableMeasurePrice",
- "country": "AF",
- "prefix": "string",
- "identifier": "string",
- "price": {
- "value": 0,
- "unit": "AUD"
}
}
}, - "status": "UNCONFIRMED",
- "cancelations": [
- {
- "number_of_canceled_units": 0,
- "cancellation_reason": {
- "@type": "PlatformDefinedImmediateSalesOrderCancellationReason",
- "name": "CUSTOMER_CANCEL"
}, - "due_to_order_cancellation": true,
- "note": "string",
- "canceled_on": "2025-03-25T16:20:17Z",
- "canceled_by": "string",
- "sales_price_at_cancelation": {
- "price": {
- "value": 0,
- "unit": "AUD"
}, - "price_is_gross": true,
- "quantity": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}, - "total_value_of_cancellation": {
- "value": 0,
- "unit": "AUD"
}
}
], - "sort_key": "string"
}
Returns OTC sales orders, sorted in ascending order by creation order date and time.
org-id required | string ID of the organization whose data is being accessed. |
from required | string <date-time> Defines the time starting from which objects are to be returned. 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 |
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 |
sales_channel_id | string When specified, only OTC sales orders for the specified sales channel are returned. |
number | string When specified, only OTC sales orders with the specified number are returned. |
Data successfully returned
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "items": [
- {
- "id": "string",
- "number": "string",
- "sales_channel_id": "string",
- "description": "string",
- "note": "string",
- "customer_information": {
- "@type": "AnonymousContactInformation",
- "name": "string",
- "contact_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "contact_email": "user@example.com",
- "contact_phone": "string",
- "unique_instance_id": "string",
- "external_data": "string",
- "user_level_identifiers": [
- {
- "identifier": "string",
- "label": "string"
}
]
}, - "status": "UNCONFIRMED",
- "kpis": {
- "number_of_items": 0,
- "total_gross_amount": {
- "value": 0,
- "unit": "AUD"
}
}, - "cancelation_info": {
- "cancellation_reason": {
- "@type": "PlatformDefinedImmediateSalesOrderCancellationReason",
- "name": "CUSTOMER_CANCEL"
}, - "note": "string",
- "canceled_on": "2025-03-25T16:20:17Z",
- "canceled_by": "string"
}
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}
org-id required | string ID of the organization whose data is being accessed. |
order-id required | string ID of the OTC sales order |
OTC sales order is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "id": "string",
- "number": "string",
- "sales_channel_id": "string",
- "description": "string",
- "note": "string",
- "customer_information": {
- "@type": "AnonymousContactInformation",
- "name": "string",
- "contact_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "contact_email": "user@example.com",
- "contact_phone": "string",
- "unique_instance_id": "string",
- "external_data": "string",
- "user_level_identifiers": [
- {
- "identifier": "string",
- "label": "string"
}
]
}, - "status": "UNCONFIRMED",
- "kpis": {
- "number_of_items": 0,
- "total_gross_amount": {
- "value": 0,
- "unit": "AUD"
}
}, - "cancelation_info": {
- "cancellation_reason": {
- "@type": "PlatformDefinedImmediateSalesOrderCancellationReason",
- "name": "CUSTOMER_CANCEL"
}, - "note": "string",
- "canceled_on": "2025-03-25T16:20:17Z",
- "canceled_by": "string"
}
}
Returns items of the specified OTC sales order, sorted in ascending order by creation order date and time.
org-id required | string ID of the organization whose data is being accessed. |
order-id required | string ID of the OTC sales order |
from required | string <date-time> Defines the time starting from which objects are to be returned. 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 |
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 |
Data successfully returned
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "items": [
- {
- "id": "string",
- "order_date_and_time": "2025-03-25T16:20:17Z",
- "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "lot_id": "string",
- "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}, - "options": [
- {
- "id": "string",
- "option_definition": {
- "option_group_id": "string",
- "option_id": "string"
}, - "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "is_single_issue": true,
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}
}
], - "extra_charges": [
- {
- "id": "string",
- "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "is_single_issue": true,
- "extra_charge_type": "DEPOSIT",
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}
}
], - "scanned_barcode": {
- "barcode_format": "UNKNOWN",
- "raw_value": "string",
- "code_value": "string",
- "parsed_data": {
- "@type": "GS1VariableMeasurePrice",
- "country": "AF",
- "prefix": "string",
- "identifier": "string",
- "price": {
- "value": 0,
- "unit": "AUD"
}
}
}, - "status": "UNCONFIRMED",
- "cancelations": [
- {
- "number_of_canceled_units": 0,
- "cancellation_reason": {
- "@type": "PlatformDefinedImmediateSalesOrderCancellationReason",
- "name": "CUSTOMER_CANCEL"
}, - "due_to_order_cancellation": true,
- "note": "string",
- "canceled_on": "2025-03-25T16:20:17Z",
- "canceled_by": "string",
- "sales_price_at_cancelation": {
- "price": {
- "value": 0,
- "unit": "AUD"
}, - "price_is_gross": true,
- "quantity": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}, - "total_value_of_cancellation": {
- "value": 0,
- "unit": "AUD"
}
}
], - "sort_key": "string"
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}
org-id required | string ID of the organization whose data is being accessed. |
order-id required | string ID of the OTC sales order |
item-id required | string ID of the OTC sales order item |
Item is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "id": "string",
- "order_date_and_time": "2025-03-25T16:20:17Z",
- "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "lot_id": "string",
- "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}, - "options": [
- {
- "id": "string",
- "option_definition": {
- "option_group_id": "string",
- "option_id": "string"
}, - "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "is_single_issue": true,
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}
}
], - "extra_charges": [
- {
- "id": "string",
- "product": {
- "id": "string",
- "type": "INVENTORY_PRODUCT"
}, - "unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_units": 0,
- "is_single_issue": true,
- "extra_charge_type": "DEPOSIT",
- "pricing_configuration": {
- "fixed_base_price_per_unit": {
- "value": 0,
- "unit": "AUD"
}, - "fixed_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}
}
], - "scanned_barcode": {
- "barcode_format": "UNKNOWN",
- "raw_value": "string",
- "code_value": "string",
- "parsed_data": {
- "@type": "GS1VariableMeasurePrice",
- "country": "AF",
- "prefix": "string",
- "identifier": "string",
- "price": {
- "value": 0,
- "unit": "AUD"
}
}
}, - "status": "UNCONFIRMED",
- "cancelations": [
- {
- "number_of_canceled_units": 0,
- "cancellation_reason": {
- "@type": "PlatformDefinedImmediateSalesOrderCancellationReason",
- "name": "CUSTOMER_CANCEL"
}, - "due_to_order_cancellation": true,
- "note": "string",
- "canceled_on": "2025-03-25T16:20:17Z",
- "canceled_by": "string",
- "sales_price_at_cancelation": {
- "price": {
- "value": 0,
- "unit": "AUD"
}, - "price_is_gross": true,
- "quantity": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}
}, - "total_value_of_cancellation": {
- "value": 0,
- "unit": "AUD"
}
}
], - "sort_key": "string"
}