Documentation Powered by ReDoc

enfore Inventory API (0.20.4)

Download OpenAPI specification:Download

enfore API for managing inventory

Inventory Settings: Product

Load the inventory management settings of a product

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

product-id
required
string

ID of the product

Responses

200

Settings are successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/product/{product-id}/settings

Production

https://external.apis.enfore.com/inventory/org/{org-id}/product/{product-id}/settings

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "product_id": "string",
  • "storage_tag":
    {
    },
  • "inventory_management_tag":
    {
    },
  • "inventory_management_mode": "MANAGED_BY_ENFORE",
  • "track_unique_items": false,
  • "threshold_for_lsi":
    {
    }
}

Update the inventory management settings of a product

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

product-id
required
string

ID of the product

Request Body schema: application/json
@type
required
string
Default: "StorageTagUpdate"
StorageTagUpdate
storage_tag
required
object (StorageTagReference)

A reference to a storage tag.

Consists of the ID of the storage tag and its scope.

The scope is either ORGANIZATION or PLATFORM. ORGANIZATION refers to tags defined by the organization itself. PLATFORM refers to tags pre-defined by the enfore platform.

Responses

200

Settings are successfully updated

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

422

Specified data is semantically incorrect.

patch/org/{org-id}/product/{product-id}/settings

Production

https://external.apis.enfore.com/inventory/org/{org-id}/product/{product-id}/settings

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "product_id": "string",
  • "storage_tag":
    {
    },
  • "inventory_management_tag":
    {
    },
  • "inventory_management_mode": "MANAGED_BY_ENFORE",
  • "track_unique_items": false,
  • "threshold_for_lsi":
    {
    }
}

Inventory Tracking: Stock Counts

Get stock counts for a product/location combination

Returns stock counts for a product/location combination.

Note that for products that do not use conditions, only a single stock count record will be returned. For products using conditions, the number of records returned depends on the number of conditions that have been used for the product at the location.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
product_id
required
string

The ID of the product for which to return stock counts.

storage_location_id
required
string

The ID of the storage location for which to return stock counts.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

422

Specified data is semantically incorrect.

get/org/{org-id}/inventory-tracking/stock-counts

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-tracking/stock-counts

Response samples

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

Inventory Tracking: Stock Count Subscriptions

Get a list of registered event consumers

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Responses

200

List of registered consumers

403

Credentials missing or not sufficient

get/org/{org-id}/inventory-tracking/stock-count-subscriptions

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-tracking/stock-count-subscriptions

Response samples

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

Register an event consumer

If the same consumer (callback_url) is already registered with the same filter, no new registation is created. Instead, 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.

filter
object (StockCountEventSubscriptionFilter)

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}/inventory-tracking/stock-count-subscriptions

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-tracking/stock-count-subscriptions

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "callback_url": "https://myserver.com/send/events/here",
  • "public_key": "string",
  • "filter":
    {
    }
}

Callback payload samples

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

Delete an event consumer registration

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}/inventory-tracking/stock-count-subscriptions/{subscription-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-tracking/stock-count-subscriptions/{subscription-id}

Response samples

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

Inventory Tracking: Stock Count Exports

Query data exports for stock counts

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. 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

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.

status
Array of strings (StockCountDataExportStatus)
Items Enum: "REQUESTED" "IN_PROCESS" "COMPLETED" "FAILED" "CANCELED"

When specified, only exports with one of the specified status values are returned. When not specified, exports are returned regardless of their status.

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}/inventory-tracking/stock-count-exports

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-tracking/stock-count-exports

Response samples

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

Create new stock count data export

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json

The parameters for the data export

export_parameters
required
any (StockCountDataExportParameters)

Responses

200

Data export 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}/inventory-tracking/stock-count-exports

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-tracking/stock-count-exports

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "description": "string",
  • "export_parameters":
    {
    },
  • "status": "REQUESTED",
  • "requested_on": "2025-03-25T13:45:23Z",
  • "requested_by_staff_member_id": "string",
  • "requested_from_device_id": "string",
  • "failure_description": "string",
  • "processing_started_on": "2025-03-25T13:45:23Z",
  • "processing_finished_on": "2025-03-25T13:45:23Z"
}

Load single stock count data export

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

export-id
required
string

ID of the data export

Responses

200

Data 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-tracking/stock-count-exports/{export-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-tracking/stock-count-exports/{export-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "description": "string",
  • "export_parameters":
    {
    },
  • "status": "REQUESTED",
  • "requested_on": "2025-03-25T13:45:23Z",
  • "requested_by_staff_member_id": "string",
  • "requested_from_device_id": "string",
  • "failure_description": "string",
  • "processing_started_on": "2025-03-25T13:45:23Z",
  • "processing_finished_on": "2025-03-25T13:45:23Z"
}

Retrieve download url for data export

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

export-id
required
string

ID of the data export

Responses

200

The download url that was requested

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-tracking/stock-count-exports/{export-id}/download

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-tracking/stock-count-exports/{export-id}/download

Response samples

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

Inventory Tracking: Log Entries

Iterate over inventory log entries.

Returns inventory log entries sorted in descending order by timestamp.

Note that the paging window defined by the parameters pagingFrom and pagingTo is limited to three months backwards from the time of the API request. When pagingFrom and/or pagingTo are specified outside that window, the API implementation will automatically adjust the parameters as needed to adhere to the limit.

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. 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

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.

product_id
string

When specified, only inventory log entries for the specified product are returned.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

422

Specified data is semantically incorrect.

get/org/{org-id}/inventory-tracking/log-entries

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-tracking/log-entries

Response samples

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

Inventory Tracking: Log Entry Subscriptions

Get a list of registered event consumers

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Responses

200

List of registered consumers

403

Credentials missing or not sufficient

get/org/{org-id}/inventory-tracking/log-entry-subscriptions

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-tracking/log-entry-subscriptions

Response samples

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

Register an event consumer

If the same consumer (callback_url) is already registered with the same filter, no new registation is created. Instead, 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.

filter
object (InventoryLogEntryEventSubscriptionFilter)

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}/inventory-tracking/log-entry-subscriptions

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-tracking/log-entry-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 an event consumer registration

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}/inventory-tracking/log-entry-subscriptions/{subscription-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-tracking/log-entry-subscriptions/{subscription-id}

Response samples

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

Inventory Tracking: Log Entry Exports

Query data exports for inventory log entries

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. 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

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.

status
Array of strings (InventoryLogEntryDataExportStatus)
Items Enum: "REQUESTED" "IN_PROCESS" "COMPLETED" "FAILED" "CANCELED"

When specified, only exports with one of the specified status values are returned. When not specified, exports are returned regardless of their status.

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}/inventory-tracking/log-entry-exports

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-tracking/log-entry-exports

Response samples

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

Create new inventory log entry data export

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json

The parameters for the data export

export_parameters
required
any (InventoryLogEntryDataExportParameters)

Responses

200

Data export 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}/inventory-tracking/log-entry-exports

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-tracking/log-entry-exports

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "description": "string",
  • "export_parameters":
    {
    },
  • "status": "REQUESTED",
  • "requested_on": "2025-03-25T13:45:23Z",
  • "requested_by_staff_member_id": "string",
  • "requested_from_device_id": "string",
  • "failure_description": "string",
  • "processing_started_on": "2025-03-25T13:45:23Z",
  • "processing_finished_on": "2025-03-25T13:45:23Z"
}

Load single inventory log entry data export

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

export-id
required
string

ID of the data export

Responses

200

Data 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-tracking/log-entry-exports/{export-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-tracking/log-entry-exports/{export-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "description": "string",
  • "export_parameters":
    {
    },
  • "status": "REQUESTED",
  • "requested_on": "2025-03-25T13:45:23Z",
  • "requested_by_staff_member_id": "string",
  • "requested_from_device_id": "string",
  • "failure_description": "string",
  • "processing_started_on": "2025-03-25T13:45:23Z",
  • "processing_finished_on": "2025-03-25T13:45:23Z"
}

Retrieve download url for data export

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

export-id
required
string

ID of the data export

Responses

200

The download url that was requested

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-tracking/log-entry-exports/{export-id}/download

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-tracking/log-entry-exports/{export-id}/download

Response samples

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

Stock Counts

Get the stock (inventory) for a given product

Returns the stock for a given product (QuantityBasedResource) for any given storage location

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

product-id
required
string

Product for which the stock details should be fetched

location-id
required
string

Storage location for which the stock needs to be fetched of a given product.

Responses

200

Data successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/stock/{product-id}/{location-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/stock/{product-id}/{location-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "product_id": "string",
  • "storage_location": "string",
  • "available":
    {
    },
  • "planned_sales":
    {
    },
  • "reserved":
    {
    },
  • "virtual":
    {
    },
  • "in_reconciliation":
    {
    }
}

Update the stock (inventory) count for a given product at a location

Update the stock for a given product (QuantityBasedResource) for any given storage location

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

product-id
required
string

Product for which the stock details should be fetched

location-id
required
string

Storage location for which the stock needs to be fetched of a given product.

Request Body schema: application/json
change_quantity
required
object (Quantity)

A Quantity represents a quantity value (i.e., a unit and an amount), for example "3 pcs" or "2.5 kg".

change_intent
required
string (StockChangeIntent)
Enum: "add" "remove" "set"

This defines the intent for changing stock value of a given resource for a given location. It's possible to add, remove, and set available stock respectively for when the available quantity has been manually (or via business process) been added, removed, or set.

condition
required
string (StockCondition)
Enum: "NEW" "REFURBISHED" "USED_LIKE_NEW" "USED_VERY_GOOD" "USED_GOOD" "USED_ACCEPTABLE" "DAMAGED"

The possible values for condition of inventor stock.

Responses

200

Updated stock info

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

patch/org/{org-id}/stock/{product-id}/{location-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/stock/{product-id}/{location-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "change_quantity":
    {
    },
  • "change_intent": "add",
  • "condition": "NEW"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "product_id": "string",
  • "storage_location": "string",
  • "available":
    {
    },
  • "planned_sales":
    {
    },
  • "reserved":
    {
    },
  • "virtual":
    {
    },
  • "in_reconciliation":
    {
    }
}

Stock Count Changes

Iterate over stock count changes.

Returns stock count changes, sorted in ascending order by "effective_on" date and time.

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. 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

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.

location_id
string

When specified, only stock count changes for the specified location are returned.

product_id
string

When specified, only stock count changes for the specified product are returned.

reason
Array of strings (StockCountChangeReason)
Items Enum: "BROKEN" "BUNDLING" "CORRECTION" "CUSTOM" "DONATED" "INITIAL_COUNT" "INTERNAL_USE" "INVENTORY_TRANSFER" "MANUFACTURED_ASSEMBLED" "OUTDATED" "PRIVATE_USE" "PURCHASE" "PURCHASE_RETURN" "SALE" "SALES_RETURN" "STOLEN" "UNBUNDLING" "UNSPECIFIED" "USED_AS_RAW_MATERIAL"

When specified, only stock count changes with one of the specified reason values 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}/stock-count-changes

Production

https://external.apis.enfore.com/inventory/org/{org-id}/stock-count-changes

Response samples

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

Get a list of registered consumers for stock count changes 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.

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/stock-count-change-subscriptions

Production

https://external.apis.enfore.com/inventory/org/{org-id}/stock-count-change-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 and remove the subscription after 30 minutes of persistent failure.

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}/stock-count-change-subscriptions

Production

https://external.apis.enfore.com/inventory/org/{org-id}/stock-count-change-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 stock count changes

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}/stock-count-change-subscriptions/{subscription-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/stock-count-change-subscriptions/{subscription-id}

Response samples

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

Inventory Shipments

Iterate over inventory shipment drafts.

Returns inventory shipment drafts, sorted in ascending order by creation order date and time.

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. 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

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.

source_storage_location_id
string

When specified, only inventory shipment drafts with the specified location as source location are returned.

destination_storage_location_id
string

When specified, only inventory shipment drafts with the specified location as destination 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}/inventory-shipment-drafts

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-shipment-drafts

Response samples

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

Create a new inventory shipment draft

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
source_storage_location
required
string

The ID of the storage location from which stock is to be transferred.

destination_storage_location
required
string

The ID of the storage location to which stock is to be transferred.

description
string <= 1024 characters

A descriptive text for the inventory shipment that can freely be set by the client.

responsible_staff
string [ 20 .. 100 ] characters

The ID of the individual contact representing the staff member responsible for the inventory shipment.

Responses

200

Inventory shipment draft is 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}/inventory-shipment-drafts

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-shipment-drafts

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "source_storage_location": "string",
  • "destination_storage_location": "string",
  • "description": "string",
  • "responsible_staff": "stringstringstringst"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "source_storage_location": "string",
  • "destination_storage_location": "string",
  • "description": "string",
  • "responsible_staff": "stringstringstringst"
}

Load an inventory shipment draft by its identifier.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

inventory-shipment-draft-id
required
string

ID of the inventory shipment draft

Responses

200

Inventory shipment draft 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-shipment-drafts/{inventory-shipment-draft-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-shipment-drafts/{inventory-shipment-draft-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "source_storage_location": "string",
  • "destination_storage_location": "string",
  • "description": "string",
  • "responsible_staff": "stringstringstringst"
}

Delete an inventory shipment draft

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

inventory-shipment-draft-id
required
string

ID of the inventory shipment draft

Responses

204

Inventory shipment draft was successfully deleted.

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/inventory-shipment-drafts/{inventory-shipment-draft-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-shipment-drafts/{inventory-shipment-draft-id}

Response samples

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

Returns inventory shipments

Returns inventory shipments for the specified interval, sorted in ascending order by order date and time.

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. 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

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.

source_storage_location_id
string

When specified, only inventory shipments with the specified location as source location are returned.

destination_storage_location_id
string

When specified, only inventory shipments with the specified location as description location are returned.

number
string

When specified, only inventory shipments with the specified number are returned.

status
Array of strings (InventoryShipmentStatus)
Items Enum: "NEW" "IN_PROCESS" "COMPLETED" "CANCELED"

When specified, only inventory shipments with one of the specified status values 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}/inventory-shipments

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-shipments

Response samples

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

Create a new inventory shipment (from an inventory shipment draft)

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json

The quoted ID of the inventory shipment draft that is to be converted to an inventory shipment

string

Responses

200

Inventory shipment is 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}/inventory-shipments

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-shipments

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "number": "string",
  • "source_storage_location": "string",
  • "destination_storage_location": "string",
  • "description": "string",
  • "responsible_staff": "stringstringstringst",
  • "status": "NEW",
  • "items":
    [
    ]
}

Load an inventory shipment by its identifier

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

inventory-shipment-id
required
string

ID of the inventory shipment

Responses

200

Inventory shipment 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-shipments/{inventory-shipment-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-shipments/{inventory-shipment-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "number": "string",
  • "source_storage_location": "string",
  • "destination_storage_location": "string",
  • "description": "string",
  • "responsible_staff": "stringstringstringst",
  • "status": "NEW",
  • "items":
    [
    ]
}

Update the status of an inventory shipment

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

inventory-shipment-id
required
string

ID of the inventory shipment

Request Body schema: text/plain
string (InventoryShipmentStatus)
Enum: "NEW" "IN_PROCESS" "COMPLETED" "CANCELED"

Responses

200

Inventory shipment status 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}/inventory-shipments/{inventory-shipment-id}/status

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-shipments/{inventory-shipment-id}/status

Response samples

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

Inventory Shipments: Items

Iterate over the items of an inventory shipment draft.

Returns items of the specified inventory shipment draft, sorted in ascending order by creation order date and time.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

inventory-shipment-draft-id
required
string

ID of the inventory shipment draft

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/inventory-shipment-drafts/{inventory-shipment-draft-id}/items

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-shipment-drafts/{inventory-shipment-draft-id}/items

Response samples

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

Add a new item to an inventory shipment draft

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

inventory-shipment-draft-id
required
string

ID of the inventory shipment draft

Request Body schema: application/json
product
required
string

The ID of the product that is to be transferred.

lot
string

The ID of the lot that the to be transferred product belong to.

quantity
required
object (Quantity)

A Quantity represents a quantity value (i.e., a unit and an amount), for example "3 pcs" or "2.5 kg".

condition
required
string (StockCondition)
Enum: "NEW" "REFURBISHED" "USED_LIKE_NEW" "USED_VERY_GOOD" "USED_GOOD" "USED_ACCEPTABLE" "DAMAGED"

The possible values for condition of inventor stock.

Responses

200

Item is 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}/inventory-shipment-drafts/{inventory-shipment-draft-id}/items

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-shipment-drafts/{inventory-shipment-draft-id}/items

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "product": "string",
  • "lot": "string",
  • "quantity":
    {
    },
  • "condition": "NEW"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "product": "string",
  • "lot": "string",
  • "quantity":
    {
    },
  • "condition": "NEW"
}

Load an item of an inventory shipment draft.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

inventory-shipment-draft-id
required
string

ID of the inventory shipment draft

item-id
required
string

ID of the item

Responses

200

Item 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-shipment-drafts/{inventory-shipment-draft-id}/items/{item-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-shipment-drafts/{inventory-shipment-draft-id}/items/{item-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "product": "string",
  • "lot": "string",
  • "quantity":
    {
    },
  • "condition": "NEW"
}

Update an item of an inventory shipment draft.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

inventory-shipment-draft-id
required
string

ID of the inventory shipment draft

item-id
required
string

ID of the item

Request Body schema: application/json
product
required
string

The ID of the product that is to be transferred.

lot
string

The ID of the lot that the to be transferred product belong to.

quantity
required
object (Quantity)

A Quantity represents a quantity value (i.e., a unit and an amount), for example "3 pcs" or "2.5 kg".

condition
required
string (StockCondition)
Enum: "NEW" "REFURBISHED" "USED_LIKE_NEW" "USED_VERY_GOOD" "USED_GOOD" "USED_ACCEPTABLE" "DAMAGED"

The possible values for condition of inventor stock.

Responses

200

Item 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}/inventory-shipment-drafts/{inventory-shipment-draft-id}/items/{item-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-shipment-drafts/{inventory-shipment-draft-id}/items/{item-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "product": "string",
  • "lot": "string",
  • "quantity":
    {
    },
  • "condition": "NEW"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "product": "string",
  • "lot": "string",
  • "quantity":
    {
    },
  • "condition": "NEW"
}

Remove an item from an inventory shipment draft

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

inventory-shipment-draft-id
required
string

ID of the inventory shipment draft

item-id
required
string

ID of the item

Responses

204

Item was successfully deleted.

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/inventory-shipment-drafts/{inventory-shipment-draft-id}/items/{item-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-shipment-drafts/{inventory-shipment-draft-id}/items/{item-id}

Response samples

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

Inventory Shipments: Subscriptions

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}/inventory-shipment-subscriptions

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-shipment-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 inventory shipments

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}/inventory-shipment-subscriptions/{subscription-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/inventory-shipment-subscriptions/{subscription-id}

Response samples

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

Goods Out Drafts

Iterate over goods out drafts.

Returns goods out drafts, sorted in ascending order by creation order date and time.

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. 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

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.

fulfillment_service_location_id
string

When specified, only goods out drafts with the specified location as source location are returned.

number
string

When specified, only goods out drafts with the specified number are returned.

type
Array of strings (GoodsOutType)
Items Enum: "SHIPMENT" "PICKUP" "ON_PREMISE_DELIVERY"

When specified, only goods out drafts with one of the specified type values 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}/goods-out-drafts

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-out-drafts

Response samples

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

Create a new goods out draft

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
type
required
string (GoodsOutType)
Enum: "SHIPMENT" "PICKUP" "ON_PREMISE_DELIVERY"

The possible types of goods outs. See the API documentation for a full explanation of the different types.

recipient
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.

number_issued_by_recipient
string [ 1 .. 256 ] characters

A "number" identifier that the recipient uses in communications to identify this GoodsOut.

parent_information
object (GoodsOutOrigin)

Information about the parent of the goods out.

If the parent object was created in the enfore platform, the reference_id field is set and contain the enfore-id of the object. Optionally, the external_reference field may be set as well.

If the parent object is not represented in the enfore platform (e.g., a goods out representing the "sending part" of an inventory shipment where the target location isn't modeled in the platform), the external_reference field must be set.

responsible_staff_id
string [ 1 .. 256 ] characters

The ID of the individual contact representing the staff member responsible for the goods out.

note
string

Additional information for this GoodsOut.

total_gross_amount
object (Money)

A Money represents a monetary value (i.e., a currency and an amount), for example "120 EUR" or "2,500.75 USD".

fulfillment_service_location_id
string [ 1 .. 256 ] characters

The id of the ServiceLocation where the fulfillment of the GoodsOut is done.

processing_location_id
string [ 1 .. 256 ] characters

The AssemblyLocation at the "fulfillmentServiceLocation" that executes the "Pick and Pack" process.

dispatch_information
any (DispatchInformation)

Information about how to dispatch the goods.

Depending on the type of the goods out, this is either a PickupInformation or a ShipmentInformation structure.

external_data
string <= 256 characters

Optional external data associated with the goods-out.

Responses

200

Goods out draft is 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}/goods-out-drafts

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-out-drafts

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "type": "SHIPMENT",
  • "recipient":
    {
    },
  • "number_issued_by_recipient": "string",
  • "parent_information":
    {
    },
  • "responsible_staff_id": "string",
  • "note": "string",
  • "total_gross_amount":
    {
    },
  • "fulfillment_service_location_id": "string",
  • "processing_location_id": "string",
  • "dispatch_information":
    {
    },
  • "external_data": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "type": "SHIPMENT",
  • "number": "string",
  • "recipient":
    {
    },
  • "number_issued_by_recipient": "string",
  • "parent_information":
    {
    },
  • "responsible_staff_id": "string",
  • "note": "string",
  • "total_gross_amount":
    {
    },
  • "fulfillment_service_location_id": "string",
  • "processing_location_id": "string",
  • "dispatch_information":
    {
    },
  • "external_data": "string"
}

Load a goods out draft by its identifier.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-out-draft-id
required
string

ID of the goods out draft

Responses

200

Goods out draft 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-drafts/{goods-out-draft-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-out-drafts/{goods-out-draft-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "type": "SHIPMENT",
  • "number": "string",
  • "recipient":
    {
    },
  • "number_issued_by_recipient": "string",
  • "parent_information":
    {
    },
  • "responsible_staff_id": "string",
  • "note": "string",
  • "total_gross_amount":
    {
    },
  • "fulfillment_service_location_id": "string",
  • "processing_location_id": "string",
  • "dispatch_information":
    {
    },
  • "external_data": "string"
}

Full update of a goods out draft by its identifier.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-out-draft-id
required
string

ID of the goods out draft

Request Body schema: application/json
type
required
string (GoodsOutType)
Enum: "SHIPMENT" "PICKUP" "ON_PREMISE_DELIVERY"

The possible types of goods outs. See the API documentation for a full explanation of the different types.

recipient
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.

number_issued_by_recipient
string [ 1 .. 256 ] characters

A "number" identifier that the recipient uses in communications to identify this GoodsOut.

parent_information
object (GoodsOutOrigin)

Information about the parent of the goods out.

If the parent object was created in the enfore platform, the reference_id field is set and contain the enfore-id of the object. Optionally, the external_reference field may be set as well.

If the parent object is not represented in the enfore platform (e.g., a goods out representing the "sending part" of an inventory shipment where the target location isn't modeled in the platform), the external_reference field must be set.

responsible_staff_id
string [ 1 .. 256 ] characters

The ID of the individual contact representing the staff member responsible for the goods out.

note
string

Additional information for this GoodsOut.

total_gross_amount
object (Money)

A Money represents a monetary value (i.e., a currency and an amount), for example "120 EUR" or "2,500.75 USD".

fulfillment_service_location_id
string [ 1 .. 256 ] characters

The id of the ServiceLocation where the fulfillment of the GoodsOut is done.

processing_location_id
string [ 1 .. 256 ] characters

The AssemblyLocation at the "fulfillmentServiceLocation" that executes the "Pick and Pack" process.

dispatch_information
any (DispatchInformation)

Information about how to dispatch the goods.

Depending on the type of the goods out, this is either a PickupInformation or a ShipmentInformation structure.

external_data
string <= 256 characters

Optional external data associated with the goods-out.

Responses

200

GoodsOutDraft 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}/goods-out-drafts/{goods-out-draft-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-out-drafts/{goods-out-draft-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "type": "SHIPMENT",
  • "recipient":
    {
    },
  • "number_issued_by_recipient": "string",
  • "parent_information":
    {
    },
  • "responsible_staff_id": "string",
  • "note": "string",
  • "total_gross_amount":
    {
    },
  • "fulfillment_service_location_id": "string",
  • "processing_location_id": "string",
  • "dispatch_information":
    {
    },
  • "external_data": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "type": "SHIPMENT",
  • "number": "string",
  • "recipient":
    {
    },
  • "number_issued_by_recipient": "string",
  • "parent_information":
    {
    },
  • "responsible_staff_id": "string",
  • "note": "string",
  • "total_gross_amount":
    {
    },
  • "fulfillment_service_location_id": "string",
  • "processing_location_id": "string",
  • "dispatch_information":
    {
    },
  • "external_data": "string"
}

Delete a goods out draft

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-out-draft-id
required
string

ID of the goods out draft

Responses

204

Goods out draft was successfully deleted.

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/goods-out-drafts/{goods-out-draft-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-out-drafts/{goods-out-draft-id}

Response samples

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

Create a new goods out draft including subresources

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
@type
required
string
Value: "GoodsOutDraftWithSubresources"
draft
required
object (GoodsOutDraft)

Draft object for a GoodsOut. Can be used to create a GoodsOut object that takes over all attributes of this draft object. In the GoodsOut some of these attributes can no longer be modified.

items
required
Array of objects (GoodsOutDraftItem)

Responses

200

Goods out draft is 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}/goods-out-drafts-full

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-out-drafts-full

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "type": "SHIPMENT",
  • "number": "string",
  • "recipient":
    {
    },
  • "number_issued_by_recipient": "string",
  • "parent_information":
    {
    },
  • "responsible_staff_id": "string",
  • "note": "string",
  • "total_gross_amount":
    {
    },
  • "fulfillment_service_location_id": "string",
  • "processing_location_id": "string",
  • "dispatch_information":
    {
    },
  • "external_data": "string"
}

Goods Out Drafts: Items

Iterate over the items of a goods out draft.

Returns items of the specified goods out draft, sorted in ascending order by creation order date and time.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-out-draft-id
required
string

ID of the goods out draft

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-drafts/{goods-out-draft-id}/items

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-out-drafts/{goods-out-draft-id}/items

Response samples

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

Add a new item to a goods out draft

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-out-draft-id
required
string

ID of the goods out draft

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

The ID of the product that is to be transferred.

quantity
required
object (Quantity)

A Quantity represents a quantity value (i.e., a unit and an amount), for example "3 pcs" or "2.5 kg".

custom_unit_id
string [ 1 .. 256 ] characters

The ID of the custom unit that is used for the item.

When set, the custom unit's code or name are used for displaying the quantities of goods for this item. When not set, the quantities are shown in the resource's display unit.

For example, assume an item with quantity 50pcs where the resource's tracking unit is 1pc. If no custom unit is given, the item's quantity is shown as "50pcs". If a custom unit "KOL" that contains/consists of 10pcs is given, the item's quantity is shown as "5 KOL" instead.

custom_unit_size
object (Quantity)

A Quantity represents a quantity value (i.e., a unit and an amount), for example "3 pcs" or "2.5 kg".

gross_amount
object (Money)

A Money represents a monetary value (i.e., a currency and an amount), for example "120 EUR" or "2,500.75 USD".

note
string

Additional information for this GoodsOutItem.

lot_id
string [ 1 .. 256 ] characters

If the resource of the item uses lots, this specifies what lot the quantity of goods that is to be sent out is to be taken from.

If this field is empty, either the resource does not use lots or no lot was specified when the GoodsOut of this item was created, because the particular process that created it does not require to specify lots.

condition_id
string [ 1 .. 256 ] characters

If the resource of the item uses conditions, this specifies what condition the quantity is to be taken from.

If this field is empty, either the resource does not use conditions or no condition was specified when the GoodsOut of this item was created, because the particular process that created it does not require to specify conditions.

unique_item_identifiers
any (UniqueItemIdentifierData)
dependents
Array of objects (GoodsOutItemDependent)

List of dependents of this item. This could be an option, a deposit etc.

This list only includes those options, deposits, etc. that are represented as dedicated items in the goods-out. Whether this is done or not depends on the configuration of the product and its options/deposits.

option_info
Array of objects (GoodsOutItemOptionInfo)

Information about the options included in the item.

This is only applicable for BTO products and, other tan "dependents", includes those options that are not represented as dedicated items in the goods-out.

sort_value
string
Default: ""

The string that the items of a goods out are sorted by for display in the client UI. Sorting uses binary comparison, if strings are equal, the order is undefined.

group_value
object (GroupValueRef)

A GroupValueRef is used to express the value by which items in a collection (e.g., GoodsOutItems in a GoodsOut) are grouped.

As group value, the enfore platform supports dedicated GroupValue objects (see Organization Structure API) but also allows other types of objects (e.g., sales channels, storage locations, ...) to be used for grouping. Thus, in addition to the ID of the group value, its type must be specified as well.

external_data
string <= 256 characters

Optional external data associated with the goods-out item.

Responses

200

Item is 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}/goods-out-drafts/{goods-out-draft-id}/items

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-out-drafts/{goods-out-draft-id}/items

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "product_id": "string",
  • "quantity":
    {
    },
  • "custom_unit_id": "string",
  • "custom_unit_size":
    {
    },
  • "gross_amount":
    {
    },
  • "note": "string",
  • "lot_id": "string",
  • "condition_id": "string",
  • "unique_item_identifiers":
    {
    },
  • "dependents":
    [
    ],
  • "option_info":
    [
    ],
  • "sort_value": "",
  • "group_value":
    {
    },
  • "external_data": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "product_id": "string",
  • "quantity":
    {
    },
  • "custom_unit_id": "string",
  • "custom_unit_size":
    {
    },
  • "gross_amount":
    {
    },
  • "note": "string",
  • "lot_id": "string",
  • "condition_id": "string",
  • "unique_item_identifiers":
    {
    },
  • "dependents":
    [
    ],
  • "option_info":
    [
    ],
  • "sort_value": "",
  • "group_value":
    {
    },
  • "external_data": "string"
}

Load an item of a goods out draft.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-out-draft-id
required
string

ID of the goods out draft

item-id
required
string

ID of the item

Responses

200

Item 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-drafts/{goods-out-draft-id}/items/{item-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-out-drafts/{goods-out-draft-id}/items/{item-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "product_id": "string",
  • "quantity":
    {
    },
  • "custom_unit_id": "string",
  • "custom_unit_size":
    {
    },
  • "gross_amount":
    {
    },
  • "note": "string",
  • "lot_id": "string",
  • "condition_id": "string",
  • "unique_item_identifiers":
    {
    },
  • "dependents":
    [
    ],
  • "option_info":
    [
    ],
  • "sort_value": "",
  • "group_value":
    {
    },
  • "external_data": "string"
}

Update an item of a goods out draft.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-out-draft-id
required
string

ID of the goods out draft

item-id
required
string

ID of the item

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

The ID of the product that is to be transferred.

quantity
required
object (Quantity)

A Quantity represents a quantity value (i.e., a unit and an amount), for example "3 pcs" or "2.5 kg".

custom_unit_id
string [ 1 .. 256 ] characters

The ID of the custom unit that is used for the item.

When set, the custom unit's code or name are used for displaying the quantities of goods for this item. When not set, the quantities are shown in the resource's display unit.

For example, assume an item with quantity 50pcs where the resource's tracking unit is 1pc. If no custom unit is given, the item's quantity is shown as "50pcs". If a custom unit "KOL" that contains/consists of 10pcs is given, the item's quantity is shown as "5 KOL" instead.

custom_unit_size
object (Quantity)

A Quantity represents a quantity value (i.e., a unit and an amount), for example "3 pcs" or "2.5 kg".

gross_amount
object (Money)

A Money represents a monetary value (i.e., a currency and an amount), for example "120 EUR" or "2,500.75 USD".

note
string

Additional information for this GoodsOutItem.

lot_id
string [ 1 .. 256 ] characters

If the resource of the item uses lots, this specifies what lot the quantity of goods that is to be sent out is to be taken from.

If this field is empty, either the resource does not use lots or no lot was specified when the GoodsOut of this item was created, because the particular process that created it does not require to specify lots.

condition_id
string [ 1 .. 256 ] characters

If the resource of the item uses conditions, this specifies what condition the quantity is to be taken from.

If this field is empty, either the resource does not use conditions or no condition was specified when the GoodsOut of this item was created, because the particular process that created it does not require to specify conditions.

unique_item_identifiers
any (UniqueItemIdentifierData)
dependents
Array of objects (GoodsOutItemDependent)

List of dependents of this item. This could be an option, a deposit etc.

This list only includes those options, deposits, etc. that are represented as dedicated items in the goods-out. Whether this is done or not depends on the configuration of the product and its options/deposits.

option_info
Array of objects (GoodsOutItemOptionInfo)

Information about the options included in the item.

This is only applicable for BTO products and, other tan "dependents", includes those options that are not represented as dedicated items in the goods-out.

sort_value
string
Default: ""

The string that the items of a goods out are sorted by for display in the client UI. Sorting uses binary comparison, if strings are equal, the order is undefined.

group_value
object (GroupValueRef)

A GroupValueRef is used to express the value by which items in a collection (e.g., GoodsOutItems in a GoodsOut) are grouped.

As group value, the enfore platform supports dedicated GroupValue objects (see Organization Structure API) but also allows other types of objects (e.g., sales channels, storage locations, ...) to be used for grouping. Thus, in addition to the ID of the group value, its type must be specified as well.

external_data
string <= 256 characters

Optional external data associated with the goods-out item.

Responses

200

Item 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}/goods-out-drafts/{goods-out-draft-id}/items/{item-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-out-drafts/{goods-out-draft-id}/items/{item-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "product_id": "string",
  • "quantity":
    {
    },
  • "custom_unit_id": "string",
  • "custom_unit_size":
    {
    },
  • "gross_amount":
    {
    },
  • "note": "string",
  • "lot_id": "string",
  • "condition_id": "string",
  • "unique_item_identifiers":
    {
    },
  • "dependents":
    [
    ],
  • "option_info":
    [
    ],
  • "sort_value": "",
  • "group_value":
    {
    },
  • "external_data": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "product_id": "string",
  • "quantity":
    {
    },
  • "custom_unit_id": "string",
  • "custom_unit_size":
    {
    },
  • "gross_amount":
    {
    },
  • "note": "string",
  • "lot_id": "string",
  • "condition_id": "string",
  • "unique_item_identifiers":
    {
    },
  • "dependents":
    [
    ],
  • "option_info":
    [
    ],
  • "sort_value": "",
  • "group_value":
    {
    },
  • "external_data": "string"
}

Remove an item from a goods out draft

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-out-draft-id
required
string

ID of the goods out draft

item-id
required
string

ID of the item

Responses

204

Item was successfully deleted.

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/goods-out-drafts/{goods-out-draft-id}/items/{item-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-out-drafts/{goods-out-draft-id}/items/{item-id}

Response samples

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

Goods Outs

Returns goods outs

Returns goods outs for the specified interval, sorted in ascending order by order date and time.

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. 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

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.

source_storage_location_id
string

When specified, only goods outs with the specified location as source location are returned.

number
string

When specified, only goods outs with the specified number are returned.

status
Array of strings (GoodsOutStatus)
Items Enum: "UNCONFIRMED" "CONFIRMED" "REJECTED" "IN_PROCESS" "FULFILLED" "CANCELED" "IN_PICKING" "PICKED" "IN_PACKING" "PACKED" "READY_FOR_PICKUP" "PICKED_UP"

When specified, only goods outs with one of the specified status values are returned.

type
Array of strings (GoodsOutType)
Items Enum: "SHIPMENT" "PICKUP" "ON_PREMISE_DELIVERY"

When specified, only goods outs with one of the specified type values 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}/goods-outs

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-outs

Response samples

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

Create a new goods out (from a goods out draft)

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

header Parameters
X-enfore-GoodsOut-usedProcessingModel
integer
Default: 1

Controls what processing model will be used for the newly created GoodsOut.

Request Body schema: application/json

The quoted ID of the goods out draft that is to be converted to a goods out

string

Responses

200

Goods out is 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}/goods-outs

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-outs

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "type": "SHIPMENT",
  • "number": "string",
  • "recipient":
    {
    },
  • "number_issued_by_recipient": "string",
  • "parent_information":
    {
    },
  • "responsible_staff_id": "string",
  • "assigned_staff_id": "string",
  • "note": "string",
  • "status": "UNCONFIRMED",
  • "status_log":
    [
    ],
  • "picking_completed": true,
  • "packing_completed": true,
  • "on_hold_information":
    {
    },
  • "on_hold_data":
    [
    ],
  • "total_gross_amount":
    {
    },
  • "fulfillment_service_location_id": "string",
  • "processing_location_id": "string",
  • "processing_configuration":
    {
    },
  • "dispatch_information":
    {
    },
  • "kpis":
    {
    },
  • "cancelation_info":
    {
    },
  • "external_data": "string"
}

Load a goods out by its identifier

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-out-id
required
string

ID of the goods out

Responses

200

Goods out 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-outs/{goods-out-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-outs/{goods-out-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "type": "SHIPMENT",
  • "number": "string",
  • "recipient":
    {
    },
  • "number_issued_by_recipient": "string",
  • "parent_information":
    {
    },
  • "responsible_staff_id": "string",
  • "assigned_staff_id": "string",
  • "note": "string",
  • "status": "UNCONFIRMED",
  • "status_log":
    [
    ],
  • "picking_completed": true,
  • "packing_completed": true,
  • "on_hold_information":
    {
    },
  • "on_hold_data":
    [
    ],
  • "total_gross_amount":
    {
    },
  • "fulfillment_service_location_id": "string",
  • "processing_location_id": "string",
  • "processing_configuration":
    {
    },
  • "dispatch_information":
    {
    },
  • "kpis":
    {
    },
  • "cancelation_info":
    {
    },
  • "external_data": "string"
}

Update a goods out

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-out-id
required
string

ID of the goods out

Request Body schema: application/json
@type
required
string
Default: "GoodsOutStatusUpdateRequest"
GoodsOutStatusUpdateRequest
status
required
string (GoodsOutStatus)
Default: "UNCONFIRMED"
Enum: "UNCONFIRMED" "CONFIRMED" "REJECTED" "IN_PROCESS" "FULFILLED" "CANCELED" "IN_PICKING" "PICKED" "IN_PACKING" "PACKED" "READY_FOR_PICKUP" "PICKED_UP"

The different states a GoodsOut can go through.

Note that there are two different state machines for GoodsOut, the current one where all the "active processing" of the GoodsOut is represented by the IN_PROCESS state and the old one where the picking, packing and fulfillment are represented as separate states.

New state machine "happy path": UNCONFIRMED -> CONFIRMED -> IN_PROCESS -> FULFILLED

Old state machine "happy path": UNCONFIRMED -> CONFIRMED -> IN_PICKING -> PICKED -> IN_PACKING -> PACKED -> READY_FOR_PICKUP -> PICKED_UP -> FULFILLED

The reason for introducing the new state machine is that the old one strictly separated the picking and the packing steps. While picking, you could not pack anything or have any packed goods. And once packing, you couldn't pick (or unpick) anymore. With that kind of model, it was impossible to handle cases like partial cancellations when the GoodsOut was already "in packing" or the reopening an already packed package to replace some goods (e.g., due to product recall or the goods being needed for something else).

  • UNCONFIRMED
    GoodsOut is waiting to be confirmed or rejected. Initial state.
  • CONFIRMED
    GoodsOut has been confirmed and will be performed.
  • REJECTED
    GoodsOut has been rejected and will not be performed.
  • IN_PROCESS
    GoodsOut is being processed. Includes the "Pick & pack" process as well as the fulfillment (delivery, pickup).
  • FULFILLED
    All packages of the GoodsOut have arrived at the recipient.
  • CANCELED
    GoodsOut processing was stopped and further processing is denied.

States only used by the old model:

  • IN_PICKING - Picking was started.
  • PICKED - Picking has ended, packing was not yet started.
  • IN_PACKING - Packing was started.
  • PACKED - Packing has ended, GoodsOut not ready for pickup yet.
  • READY_FOR_PICKUP - All packages have been prepared and can be picked up.
  • PICKED_UP - All packages of the have been picked up.
reason
any (GoodsOutCancellationReason)

Responses

200

Goods out 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.

patch/org/{org-id}/goods-outs/{goods-out-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-outs/{goods-out-id}

Request samples

Content type
application/json
Example
GoodsOutStatusUpdateRequest
Copy
 Expand all Collapse all
{
  • "@type": "GoodsOutStatusUpdateRequest",
  • "status": "UNCONFIRMED",
  • "reason":
    {
    }
}

Response samples

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

Update the status of a goods out Deprecated

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-out-id
required
string

ID of the goods out

Request Body schema: application/json
status
required
string (GoodsOutStatus)
Default: "UNCONFIRMED"
Enum: "UNCONFIRMED" "CONFIRMED" "REJECTED" "IN_PROCESS" "FULFILLED" "CANCELED" "IN_PICKING" "PICKED" "IN_PACKING" "PACKED" "READY_FOR_PICKUP" "PICKED_UP"

The different states a GoodsOut can go through.

Note that there are two different state machines for GoodsOut, the current one where all the "active processing" of the GoodsOut is represented by the IN_PROCESS state and the old one where the picking, packing and fulfillment are represented as separate states.

New state machine "happy path": UNCONFIRMED -> CONFIRMED -> IN_PROCESS -> FULFILLED

Old state machine "happy path": UNCONFIRMED -> CONFIRMED -> IN_PICKING -> PICKED -> IN_PACKING -> PACKED -> READY_FOR_PICKUP -> PICKED_UP -> FULFILLED

The reason for introducing the new state machine is that the old one strictly separated the picking and the packing steps. While picking, you could not pack anything or have any packed goods. And once packing, you couldn't pick (or unpick) anymore. With that kind of model, it was impossible to handle cases like partial cancellations when the GoodsOut was already "in packing" or the reopening an already packed package to replace some goods (e.g., due to product recall or the goods being needed for something else).

  • UNCONFIRMED
    GoodsOut is waiting to be confirmed or rejected. Initial state.
  • CONFIRMED
    GoodsOut has been confirmed and will be performed.
  • REJECTED
    GoodsOut has been rejected and will not be performed.
  • IN_PROCESS
    GoodsOut is being processed. Includes the "Pick & pack" process as well as the fulfillment (delivery, pickup).
  • FULFILLED
    All packages of the GoodsOut have arrived at the recipient.
  • CANCELED
    GoodsOut processing was stopped and further processing is denied.

States only used by the old model:

  • IN_PICKING - Picking was started.
  • PICKED - Picking has ended, packing was not yet started.
  • IN_PACKING - Packing was started.
  • PACKED - Packing has ended, GoodsOut not ready for pickup yet.
  • READY_FOR_PICKUP - All packages have been prepared and can be picked up.
  • PICKED_UP - All packages of the have been picked up.
cancelation_info
object (GoodsOutCancelationInfo)

The reason why GoodsOut was canceled.

Responses

200

Goods out status 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.

patch/org/{org-id}/goods-outs/{goods-out-id}/status

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-outs/{goods-out-id}/status

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "status": "UNCONFIRMED",
  • "cancelation_info":
    {
    }
}

Response samples

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

Goods Outs: Items

Iterate over the items of a goods out.

Returns items of the specified goods out, sorted in ascending order by creation order date and time.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-out-id
required
string

ID of the goods out

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/goods-outs/{goods-out-id}/items

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-outs/{goods-out-id}/items

Response samples

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

Load an item of a goods out.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-out-id
required
string

ID of the goods out

item-id
required
string

ID of the goods out item

Responses

200

Item is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/goods-outs/{goods-out-id}/items/{item-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-outs/{goods-out-id}/items/{item-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "product_id": "string",
  • "quantity":
    {
    },
  • "custom_unit_id": "string",
  • "custom_unit_size":
    {
    },
  • "dependents":
    [
    ],
  • "option_info":
    [
    ],
  • "sort_value": "",
  • "group_value":
    {
    },
  • "gross_amount":
    {
    },
  • "note": "string",
  • "external_data": "string",
  • "lot_id": "string",
  • "condition_id": "string",
  • "unique_item_identifiers":
    {
    },
  • "picked_quantity":
    {
    },
  • "picked_lot_id": "string",
  • "picked_condition_id": "string",
  • "picked_unique_item_identifiers":
    {
    },
  • "picked_values_change_log":
    [
    ],
  • "is_picked": true,
  • "is_overpicked": true,
  • "missing_picked_values_waivers":
    [
    ],
  • "picking_storage_location_id": "string",
  • "storage_location_compatibility_waiver":
    {
    },
  • "packed_quantity":
    {
    },
  • "is_overpacked": true,
  • "failed_quantity":
    {
    },
  • "canceled_quantity":
    {
    },
  • "split_from":
    {
    },
  • "split_quantity":
    {
    }
}

Update an item of a goods out

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-out-id
required
string

ID of the goods out

item-id
required
string

ID of the goods out item

Request Body schema: application/json
@type
required
string
Default: "GoodsOutItemUpdateExternalDataRequest"
GoodsOutItemUpdateExternalDataRequest
external_data
string <= 256 characters

The new external data to associate with the goods-out item.

Providing this field will replace any existing external data with the value provided. Omitting this field will cause the deletion of any existing external data.

Responses

200

Goods out item 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.

patch/org/{org-id}/goods-outs/{goods-out-id}/items/{item-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-outs/{goods-out-id}/items/{item-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "@type": "GoodsOutItemUpdateExternalDataRequest",
  • "external_data": "string"
}

Response samples

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

Goods Outs: Packages

Iterate over the packages of a goods out.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-out-id
required
string

ID of the goods out

Responses

200

Packages 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}/goods-outs/{goods-out-id}/packages

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-outs/{goods-out-id}/packages

Response samples

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

Load a package of a goods out.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-out-id
required
string

ID of the goods out

goods-out-package-id
required
string

ID of the goods out package

Responses

200

Package is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/goods-outs/{goods-out-id}/packages/{goods-out-package-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-outs/{goods-out-id}/packages/{goods-out-package-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "status": "IN_PACKING",
  • "status_log":
    [
    ],
  • "send_label":
    {
    },
  • "return_label":
    {
    },
  • "signature_id": "string",
  • "package_material_product_id": "string",
  • "used_container_material":
    {
    },
  • "shipping_dimensions":
    {
    },
  • "note": "string",
  • "picked_up_on": "2025-03-25T13:45:26Z",
  • "fulfilled_on": "2025-03-25T13:45:26Z"
}

Goods Outs: On Hold

Add a new "manual on hold" to a goods out

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-out-id
required
string

ID of the goods out

Request Body schema: application/json
reason
any (GoodsOutManualOnHoldReason)
description
string <= 1024 characters

An optional description further providing information about the "on hold".

Responses

200

Goods out "on hold" is 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}/goods-outs/{goods-out-id}/on-hold

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-outs/{goods-out-id}/on-hold

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "classification": "MANUAL",
  • "creation_context": "ENFOREPOS_CLIENT_UI",
  • "description": "string",
  • "reason":
    {
    },
  • "status": "ACTIVE",
  • "status_log":
    [
    ]
}

Update a goods out "on hold" object

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-out-id
required
string

ID of the goods out

hold-id
required
string

ID of the goods out "on hold"

Request Body schema: application/json
@type
required
string
Default: "GoodsOutOnHoldReleaseRequest"
GoodsOutOnHoldReleaseRequest

Responses

200

Goods out "on hold" 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.

patch/org/{org-id}/goods-outs/{goods-out-id}/on-hold/{hold-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-outs/{goods-out-id}/on-hold/{hold-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "@type": "GoodsOutOnHoldReleaseRequest"
}

Response samples

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

Goods Outs: Subscriptions

Get a list of registered consumers for goods out 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}/goods-out-subscriptions

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-out-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}/goods-out-subscriptions

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-out-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 goods outs

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}/goods-out-subscriptions/{subscription-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-out-subscriptions/{subscription-id}

Response samples

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

Goods Out Cancellation Requests

Iterate over goods out cancellation requests.

Returns goods out cancellation requests, sorted in ascending order by creation order date and time.

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. 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

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.

fulfillment_service_location_id
string

When specified, only cancellation requests for goods outs with the specified location as source 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}/goods-out-cancellation-requests

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-out-cancellation-requests

Response samples

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

Create a new goods out cancellation request

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

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

The ID of the goods-out that is to be canceled.

cancellation_type
required
string (CancellationType)
Value: "FULL_CANCELLATION"

The types of cancellation that can be requested.

  • FULL_CANCELLATION
    The full GoodsOut is to be canceled.
issuer_type
required
string (GoodsOutCancellationRequestIssuerType)
Enum: "GOODS_OUT_STAFF" "PARENT_PROCESS"

Indicates the type of issuer that recorded the cancellation request.

  • GOODS_OUT_STAFF
    The cancellation was requested by the staff responsible for processing the GoodsOut.
  • PARENT_PROCESS
    The cancellation was requested from the parent process of the GoodsOut.
reason
any (GoodsOutCancellationReason)
note
string

An optional note that allows poviding futher reasoning or instructions for the cancellation.

Responses

200

Goods out cancellation request is 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}/goods-out-cancellation-requests

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-out-cancellation-requests

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "goods_out_id": "string",
  • "cancellation_type": "FULL_CANCELLATION",
  • "issuer_type": "GOODS_OUT_STAFF",
  • "reason":
    {
    },
  • "note": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "goods_out_id": "string",
  • "goods_out_parent_information":
    {
    },
  • "goods_out_service_location_id": "string",
  • "goods_out_processing_location_id": "string",
  • "cancellation_type": "FULL_CANCELLATION",
  • "issuer_type": "GOODS_OUT_STAFF",
  • "creation_context": "ENFOREPOS_CLIENT_UI",
  • "reason":
    {
    },
  • "note": "string",
  • "status": "PENDING",
  • "status_log":
    [
    ],
  • "cancellation_performed": false
}

Load a goods out cancellation request by its identifier.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

request-id
required
string

ID of the goods out cancellation request

Responses

200

Goods out cancellation request 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-cancellation-requests/{request-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-out-cancellation-requests/{request-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "goods_out_id": "string",
  • "goods_out_parent_information":
    {
    },
  • "goods_out_service_location_id": "string",
  • "goods_out_processing_location_id": "string",
  • "cancellation_type": "FULL_CANCELLATION",
  • "issuer_type": "GOODS_OUT_STAFF",
  • "creation_context": "ENFOREPOS_CLIENT_UI",
  • "reason":
    {
    },
  • "note": "string",
  • "status": "PENDING",
  • "status_log":
    [
    ],
  • "cancellation_performed": false
}

Update a goods out cancellation request

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

request-id
required
string

ID of the goods out cancellation request

Request Body schema: application/json
@type
required
string
Default: "GoodsOutCancellationRequestAcceptRequest"
GoodsOutCancellationRequestAcceptRequest

Responses

200

Goods out cancellation request 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.

patch/org/{org-id}/goods-out-cancellation-requests/{request-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-out-cancellation-requests/{request-id}

Request samples

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

Response samples

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

Goods Out Cancellation Requests: Subscriptions

Get a list of registered consumers for goods out cancellation request 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}/goods-out-cancellation-request-subscriptions

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-out-cancellation-request-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}/goods-out-cancellation-request-subscriptions

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-out-cancellation-request-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 goods out cancellation requests

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}/goods-out-cancellation-request-subscriptions/{subscription-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-out-cancellation-request-subscriptions/{subscription-id}

Response samples

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

Goods In Drafts

Iterate over goods in drafts.

Returns goods in drafts, sorted in ascending order by creation order date and time.

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. 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

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.

number
string

When specified, only goods outs with the specified number are returned.

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}/goods-in-drafts

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-drafts

Response samples

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

Create a new goods in draft

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

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

A human readable or scannable identifier from the delivery note for the GoodsIn.

sender
required
any (ContactInformation)

Information about a contact.

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

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

processing_service_location_id
string [ 1 .. 256 ] characters

The ID of the ServiceLocation where the processing of the GoodsIn will be done.

processing_location_id
string [ 1 .. 256 ] characters

The ID of the AssemblyLocation at the ServiceLocation specified via "processing_service_location_id" where the "Unpack and Resolve" process will be executed.

responsible_staff_id
string [ 1 .. 256 ] characters

The ID of the individual contact representing the staff member responsible for the goods in.

note
string

Additional information for this GoodsOut.

advised_delivery_timespan
object (TimeRange)
expected_package_count
integer

Expected count of packages. If not set than it is unknown.

is_controlled_by_system
required
boolean
Default: true

Flag indicating whether this goods-in is controlled by a technical system or not.

Goods-ins that are controlled by a technical system do not normally allow the user to add additional goods-in items on the fly. There is a setting that enables adding items to system-controlled goods-ins though.

Note that the "technical system" may be an external system (e.g., enterprise organizations using SAP as "source of truth") or the enfore platform itself (when a GoodsIn in org A is created due to a GoodsOut in org B).

external_data
string <= 256 characters

Optional external data associated with the goods-in.

Responses

200

Goods in draft is 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}/goods-in-drafts

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-drafts

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "delivery_note_number": "string",
  • "sender":
    {
    },
  • "processing_service_location_id": "string",
  • "processing_location_id": "string",
  • "responsible_staff_id": "string",
  • "note": "string",
  • "advised_delivery_timespan":
    {
    },
  • "expected_package_count": 0,
  • "is_controlled_by_system": true,
  • "external_data": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "number": "string",
  • "delivery_note_number": "string",
  • "sender":
    {
    },
  • "processing_service_location_id": "string",
  • "processing_location_id": "string",
  • "responsible_staff_id": "string",
  • "note": "string",
  • "advised_delivery_timespan":
    {
    },
  • "expected_package_count": 0,
  • "is_controlled_by_system": true,
  • "external_data": "string"
}

Load a goods in draft by its identifier.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

Responses

200

Goods in draft 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-drafts/{goods-in-draft-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-drafts/{goods-in-draft-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "number": "string",
  • "delivery_note_number": "string",
  • "sender":
    {
    },
  • "processing_service_location_id": "string",
  • "processing_location_id": "string",
  • "responsible_staff_id": "string",
  • "note": "string",
  • "advised_delivery_timespan":
    {
    },
  • "expected_package_count": 0,
  • "is_controlled_by_system": true,
  • "external_data": "string"
}

Full update of a goods in draft by its identifier.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

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

A human readable or scannable identifier from the delivery note for the GoodsIn.

sender
required
any (ContactInformation)

Information about a contact.

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

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

processing_service_location_id
string [ 1 .. 256 ] characters

The ID of the ServiceLocation where the processing of the GoodsIn will be done.

processing_location_id
string [ 1 .. 256 ] characters

The ID of the AssemblyLocation at the ServiceLocation specified via "processing_service_location_id" where the "Unpack and Resolve" process will be executed.

responsible_staff_id
string [ 1 .. 256 ] characters

The ID of the individual contact representing the staff member responsible for the goods in.

note
string

Additional information for this GoodsOut.

advised_delivery_timespan
object (TimeRange)
expected_package_count
integer

Expected count of packages. If not set than it is unknown.

is_controlled_by_system
required
boolean
Default: true

Flag indicating whether this goods-in is controlled by a technical system or not.

Goods-ins that are controlled by a technical system do not normally allow the user to add additional goods-in items on the fly. There is a setting that enables adding items to system-controlled goods-ins though.

Note that the "technical system" may be an external system (e.g., enterprise organizations using SAP as "source of truth") or the enfore platform itself (when a GoodsIn in org A is created due to a GoodsOut in org B).

external_data
string <= 256 characters

Optional external data associated with the goods-in.

Responses

200

GoodsInDraft 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}/goods-in-drafts/{goods-in-draft-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-drafts/{goods-in-draft-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "delivery_note_number": "string",
  • "sender":
    {
    },
  • "processing_service_location_id": "string",
  • "processing_location_id": "string",
  • "responsible_staff_id": "string",
  • "note": "string",
  • "advised_delivery_timespan":
    {
    },
  • "expected_package_count": 0,
  • "is_controlled_by_system": true,
  • "external_data": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "number": "string",
  • "delivery_note_number": "string",
  • "sender":
    {
    },
  • "processing_service_location_id": "string",
  • "processing_location_id": "string",
  • "responsible_staff_id": "string",
  • "note": "string",
  • "advised_delivery_timespan":
    {
    },
  • "expected_package_count": 0,
  • "is_controlled_by_system": true,
  • "external_data": "string"
}

Delete a goods in draft

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

Responses

204

Goods in draft was successfully deleted.

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/goods-in-drafts/{goods-in-draft-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-drafts/{goods-in-draft-id}

Response samples

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

Create a new goods in draft including subresources

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
@type
required
string
Value: "GoodsInDraftWithSubresources"
draft
required
object (GoodsInDraft)
items
required
Array of objects (GoodsInDraftItem)
packages
required
object

The packages for the new GoodsInDraft.

The property names are used as identifiers for the packages so that items in the GoodsInDraftWithSubresources can reference their package via their package_id field.

The property names must be MongoDB ObjectIDs and match the regular expression ^[0-9a-f]{24}$.

For example, 63593676899e2e39b6adf698.

The enfore platform will use that identifier for the package of the draft.

ATTN: When the GoodsInDraftPackage has an idempotency_key, the value of that key must match the used property name. Otherwise, the API call will fail with 422 UNPROCESSABLE CONTENT.

origins
object

The origins for the new GoodsInDraft.

The property names are used as identifiers for the origins so that items in the GoodsInDraftWithSubresources can reference their origin via their origin_id field.

The property names must be MongoDB ObjectIDs and match the regular expression ^[0-9a-f]{24}$.

For example, 63593676899e2e39b6adf698.

The enfore platform will use that identifier for the origin of the draft.

ATTN: When the GoodsInOrigin has an idempotency_key, the value of that key must match the used property name. Otherwise, the API call will fail with 422 UNPROCESSABLE CONTENT.

external_references
Array of objects (GoodsInExternalReference)

Responses

200

Goods in draft is successfully created.

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

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-drafts-full

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-drafts-full

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "@type": "GoodsInDraftWithSubresources",
  • "draft":
    {
    },
  • "items":
    [
    ],
  • "packages":
    {
    },
  • "origins":
    {
    },
  • "external_references":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "number": "string",
  • "delivery_note_number": "string",
  • "sender":
    {
    },
  • "processing_service_location_id": "string",
  • "processing_location_id": "string",
  • "responsible_staff_id": "string",
  • "note": "string",
  • "advised_delivery_timespan":
    {
    },
  • "expected_package_count": 0,
  • "is_controlled_by_system": true,
  • "external_data": "string"
}

Goods In Drafts: Items

Iterate over the items of a goods in draft.

Returns items of the specified goods in draft, sorted in ascending order by creation order date and time.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

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}/goods-in-drafts/{goods-in-draft-id}/items

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-drafts/{goods-in-draft-id}/items

Response samples

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

Add a new item to a goods in draft

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

Request Body schema: application/json
idempotency_key
string 24 characters

An idempotency key that can be used as part of the calls to create new items (basic "draft item"-POST or POST of "draft with subresources") to ensure no duplicate items get created.

The key must be a valid MongoDB ObjectID in lowercase hexadecimal string form.

When present, the enfore platform will check if an item with the specified key already exists:

  • If no such item exists, the new item is created normally.
  • If such an item exists and both matches the item from the POST request and belongs to the goods-in draft that the post is addressing, the API does not create a new item but returns a 200 OK response.
  • If such an item exists and either differs from the item in the POST or belongs to a goods-in draft other than the one the POST is addressing, the API call will fail with a 409 CONFLICT and a suitable Problem.

When not present, the item will be created normally.

product_id
required
string [ 1 .. 256 ] characters

The ID of the product that is to be transferred.

primary_product_identifier
object (ProductIdentifierWithLabel)

An identifier for the product.

Note that any identifier used here must also be present as part of the product or product/alternative unit master data.

secondary_product_identifier
object (ProductIdentifierWithLabel)

An identifier for the product.

Note that any identifier used here must also be present as part of the product or product/alternative unit master data.

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".

custom_unit_id
string [ 1 .. 256 ] characters

The custom unit that is used for the item.

When set, the custom unit's code or name are used for displaying the quantities of goods for this item. When not the, the quantities are shown in the resource's display unit.

For example, assume an item with expectedNumberOfUnits = 3 and unit = 6pcs. If no custom unit is given, the expected quantity is shown as "3 x 6pcs". If a custom unit "KOL" is given, the expected quantity is shown as "3 KOL" instead.

expected_number_of_units
number <int64> >= 0

The number of units that are expected for the item.

expected_unique_item_identifiers
any (UniqueItemIdentifierData)
expected_lot_id
string [ 1 .. 256 ] characters

The ID of the lot that is the goods are expected to belong to.

If this field is empty, either the resource does not use lots or the lot was not specified yet.

expected_condition_id
string [ 1 .. 256 ] characters

The ID of the condition that is the goods are expected to have.

If this field is empty, either the resource does not use conditions or the condition was not specified yet.

origin_id
string [ 1 .. 256 ] characters

The ID of the GoodsInOrigin that the item is the delivery for.

package_id
required
string [ 1 .. 256 ] characters

The ID of the package that the item belongs to.

note
string

Additional information for this item.

position_identifier
string

Optional identifier for the goods-in item to be shown to users in the UI and used as identifier for looking-up items.

sort_value
required
string
Default: ""

The string that the items of a goods in are sorted by for display in the client UI. Sorting uses binary comparison, if strings are equal, the order is undefined.

group_value
object (GroupValueRef)

A GroupValueRef is used to express the value by which items in a collection (e.g., GoodsOutItems in a GoodsOut) are grouped.

As group value, the enfore platform supports dedicated GroupValue objects (see Organization Structure API) but also allows other types of objects (e.g., sales channels, storage locations, ...) to be used for grouping. Thus, in addition to the ID of the group value, its type must be specified as well.

is_controlled_by_system
required
boolean
Default: true

Flag indicating whether this item is controlled by a technical system or not.

Items that are controlled by a technical system cannot be deleted by the user and the user cannot modify the "expected values" of such items. Modifications of the "received values", resolutions and the note are of course still possible.

Note that the "technical system" may be an external system (e.g., enterprise organizations using SAP as "source of truth") or the enfore platform itself (when a GoodsIn in org A is created due to a GoodsOut in org B).

external_data
string <= 256 characters

Optional external data associated with the goods-in item.

Responses

200

Item is successfully created.

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

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-drafts/{goods-in-draft-id}/items

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-drafts/{goods-in-draft-id}/items

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "idempotency_key": "6526b14b6296fe5a452eb156",
  • "product_id": "string",
  • "primary_product_identifier":
    {
    },
  • "secondary_product_identifier":
    {
    },
  • "unit":
    {
    },
  • "custom_unit_id": "string",
  • "expected_number_of_units": 0,
  • "expected_unique_item_identifiers":
    {
    },
  • "expected_lot_id": "string",
  • "expected_condition_id": "string",
  • "origin_id": "string",
  • "package_id": "string",
  • "note": "string",
  • "position_identifier": "string",
  • "sort_value": "",
  • "group_value":
    {
    },
  • "is_controlled_by_system": true,
  • "external_data": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "idempotency_key": "6526b14b6296fe5a452eb156",
  • "product_id": "string",
  • "primary_product_identifier":
    {
    },
  • "secondary_product_identifier":
    {
    },
  • "unit":
    {
    },
  • "custom_unit_id": "string",
  • "expected_number_of_units": 0,
  • "expected_unique_item_identifiers":
    {
    },
  • "expected_lot_id": "string",
  • "expected_condition_id": "string",
  • "origin_id": "string",
  • "package_id": "string",
  • "note": "string",
  • "position_identifier": "string",
  • "sort_value": "",
  • "group_value":
    {
    },
  • "is_controlled_by_system": true,
  • "external_data": "string"
}

Load an item of a goods in draft.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

item-id
required
string

ID of the item

Responses

200

Item is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/goods-in-drafts/{goods-in-draft-id}/items/{item-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-drafts/{goods-in-draft-id}/items/{item-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "idempotency_key": "6526b14b6296fe5a452eb156",
  • "product_id": "string",
  • "primary_product_identifier":
    {
    },
  • "secondary_product_identifier":
    {
    },
  • "unit":
    {
    },
  • "custom_unit_id": "string",
  • "expected_number_of_units": 0,
  • "expected_unique_item_identifiers":
    {
    },
  • "expected_lot_id": "string",
  • "expected_condition_id": "string",
  • "origin_id": "string",
  • "package_id": "string",
  • "note": "string",
  • "position_identifier": "string",
  • "sort_value": "",
  • "group_value":
    {
    },
  • "is_controlled_by_system": true,
  • "external_data": "string"
}

Update an item of a goods in draft.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

item-id
required
string

ID of the item

Request Body schema: application/json
idempotency_key
string 24 characters

An idempotency key that can be used as part of the calls to create new items (basic "draft item"-POST or POST of "draft with subresources") to ensure no duplicate items get created.

The key must be a valid MongoDB ObjectID in lowercase hexadecimal string form.

When present, the enfore platform will check if an item with the specified key already exists:

  • If no such item exists, the new item is created normally.
  • If such an item exists and both matches the item from the POST request and belongs to the goods-in draft that the post is addressing, the API does not create a new item but returns a 200 OK response.
  • If such an item exists and either differs from the item in the POST or belongs to a goods-in draft other than the one the POST is addressing, the API call will fail with a 409 CONFLICT and a suitable Problem.

When not present, the item will be created normally.

product_id
required
string [ 1 .. 256 ] characters

The ID of the product that is to be transferred.

primary_product_identifier
object (ProductIdentifierWithLabel)

An identifier for the product.

Note that any identifier used here must also be present as part of the product or product/alternative unit master data.

secondary_product_identifier
object (ProductIdentifierWithLabel)

An identifier for the product.

Note that any identifier used here must also be present as part of the product or product/alternative unit master data.

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".

custom_unit_id
string [ 1 .. 256 ] characters

The custom unit that is used for the item.

When set, the custom unit's code or name are used for displaying the quantities of goods for this item. When not the, the quantities are shown in the resource's display unit.

For example, assume an item with expectedNumberOfUnits = 3 and unit = 6pcs. If no custom unit is given, the expected quantity is shown as "3 x 6pcs". If a custom unit "KOL" is given, the expected quantity is shown as "3 KOL" instead.

expected_number_of_units
number <int64> >= 0

The number of units that are expected for the item.

expected_unique_item_identifiers
any (UniqueItemIdentifierData)
expected_lot_id
string [ 1 .. 256 ] characters

The ID of the lot that is the goods are expected to belong to.

If this field is empty, either the resource does not use lots or the lot was not specified yet.

expected_condition_id
string [ 1 .. 256 ] characters

The ID of the condition that is the goods are expected to have.

If this field is empty, either the resource does not use conditions or the condition was not specified yet.

origin_id
string [ 1 .. 256 ] characters

The ID of the GoodsInOrigin that the item is the delivery for.

package_id
required
string [ 1 .. 256 ] characters

The ID of the package that the item belongs to.

note
string

Additional information for this item.

position_identifier
string

Optional identifier for the goods-in item to be shown to users in the UI and used as identifier for looking-up items.

sort_value
required
string
Default: ""

The string that the items of a goods in are sorted by for display in the client UI. Sorting uses binary comparison, if strings are equal, the order is undefined.

group_value
object (GroupValueRef)

A GroupValueRef is used to express the value by which items in a collection (e.g., GoodsOutItems in a GoodsOut) are grouped.

As group value, the enfore platform supports dedicated GroupValue objects (see Organization Structure API) but also allows other types of objects (e.g., sales channels, storage locations, ...) to be used for grouping. Thus, in addition to the ID of the group value, its type must be specified as well.

is_controlled_by_system
required
boolean
Default: true

Flag indicating whether this item is controlled by a technical system or not.

Items that are controlled by a technical system cannot be deleted by the user and the user cannot modify the "expected values" of such items. Modifications of the "received values", resolutions and the note are of course still possible.

Note that the "technical system" may be an external system (e.g., enterprise organizations using SAP as "source of truth") or the enfore platform itself (when a GoodsIn in org A is created due to a GoodsOut in org B).

external_data
string <= 256 characters

Optional external data associated with the goods-in item.

Responses

200

Item 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}/goods-in-drafts/{goods-in-draft-id}/items/{item-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-drafts/{goods-in-draft-id}/items/{item-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "idempotency_key": "6526b14b6296fe5a452eb156",
  • "product_id": "string",
  • "primary_product_identifier":
    {
    },
  • "secondary_product_identifier":
    {
    },
  • "unit":
    {
    },
  • "custom_unit_id": "string",
  • "expected_number_of_units": 0,
  • "expected_unique_item_identifiers":
    {
    },
  • "expected_lot_id": "string",
  • "expected_condition_id": "string",
  • "origin_id": "string",
  • "package_id": "string",
  • "note": "string",
  • "position_identifier": "string",
  • "sort_value": "",
  • "group_value":
    {
    },
  • "is_controlled_by_system": true,
  • "external_data": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "idempotency_key": "6526b14b6296fe5a452eb156",
  • "product_id": "string",
  • "primary_product_identifier":
    {
    },
  • "secondary_product_identifier":
    {
    },
  • "unit":
    {
    },
  • "custom_unit_id": "string",
  • "expected_number_of_units": 0,
  • "expected_unique_item_identifiers":
    {
    },
  • "expected_lot_id": "string",
  • "expected_condition_id": "string",
  • "origin_id": "string",
  • "package_id": "string",
  • "note": "string",
  • "position_identifier": "string",
  • "sort_value": "",
  • "group_value":
    {
    },
  • "is_controlled_by_system": true,
  • "external_data": "string"
}

Remove an item from a goods in draft

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

item-id
required
string

ID of the item

Responses

204

Item was successfully deleted.

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/goods-in-drafts/{goods-in-draft-id}/items/{item-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-drafts/{goods-in-draft-id}/items/{item-id}

Response samples

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

Goods In Drafts: Packages

Load all packages for the given goods in draft

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

Responses

200

packages are successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/goods-in-drafts/{goods-in-draft-id}/packages

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-drafts/{goods-in-draft-id}/packages

Response samples

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

Add a new package to a goods in draft

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

Request Body schema: application/json
idempotency_key
string 24 characters

An idempotency key that can be used as part of the calls to create packages (POST /org/{org-id}/goods-in-drafts/{goods-in-draft-id}/packages) to ensure no duplicate packages get created.

The key must be a valid MongoDB ObjectID in lowercase hexadecimal string form.

When present, the enfore platform will check if a package with the specified key already exists in the goods-in draft:

  • If no such package exists, the new package is created normally.
  • If such a package exists and matches the package from the POST request, the API does not create a new item but returns a 200 OK response.
  • If such a package exists but does not match the package from the POST request, the API call will fail with a 409 CONFLICT and a suitable Problem.

When not present, the package will be created normally.

package_number
string [ 1 .. 256 ] characters

A number that identifies the package.

This may be an identifier provided by the sender (e.g., via a delivery notice) or it may be assigned by the receiving organization for management of the package.

Will be part of the identifiers by which GoodsIns and their packages can be looked up.

tracking_number
string [ 1 .. 256 ] characters

A tracking number for the package.

Tracking numbers are usually assigned by the carrier handling the shipping of the package.

Will be part of the identifiers by which GoodsIns and their packages can be looked up.

Responses

200

package is successfully created.

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

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-drafts/{goods-in-draft-id}/packages

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-drafts/{goods-in-draft-id}/packages

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "idempotency_key": "6526b14b6296fe5a452eb156",
  • "package_number": "string",
  • "tracking_number": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "idempotency_key": "6526b14b6296fe5a452eb156",
  • "package_number": "string",
  • "tracking_number": "string"
}

Load a package of a goods in draft.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

goods-in-draft-package-id
required
string

ID of the goods in draft package

Responses

200

Package is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/goods-in-drafts/{goods-in-draft-id}/packages/{goods-in-draft-package-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-drafts/{goods-in-draft-id}/packages/{goods-in-draft-package-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "idempotency_key": "6526b14b6296fe5a452eb156",
  • "package_number": "string",
  • "tracking_number": "string"
}

Update a package of a goods in draft.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

goods-in-draft-package-id
required
string

ID of the goods in draft package

Request Body schema: application/json
idempotency_key
string 24 characters

An idempotency key that can be used as part of the calls to create packages (POST /org/{org-id}/goods-in-drafts/{goods-in-draft-id}/packages) to ensure no duplicate packages get created.

The key must be a valid MongoDB ObjectID in lowercase hexadecimal string form.

When present, the enfore platform will check if a package with the specified key already exists in the goods-in draft:

  • If no such package exists, the new package is created normally.
  • If such a package exists and matches the package from the POST request, the API does not create a new item but returns a 200 OK response.
  • If such a package exists but does not match the package from the POST request, the API call will fail with a 409 CONFLICT and a suitable Problem.

When not present, the package will be created normally.

package_number
string [ 1 .. 256 ] characters

A number that identifies the package.

This may be an identifier provided by the sender (e.g., via a delivery notice) or it may be assigned by the receiving organization for management of the package.

Will be part of the identifiers by which GoodsIns and their packages can be looked up.

tracking_number
string [ 1 .. 256 ] characters

A tracking number for the package.

Tracking numbers are usually assigned by the carrier handling the shipping of the package.

Will be part of the identifiers by which GoodsIns and their packages can be looked up.

Responses

200

Package 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}/goods-in-drafts/{goods-in-draft-id}/packages/{goods-in-draft-package-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-drafts/{goods-in-draft-id}/packages/{goods-in-draft-package-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "idempotency_key": "6526b14b6296fe5a452eb156",
  • "package_number": "string",
  • "tracking_number": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "idempotency_key": "6526b14b6296fe5a452eb156",
  • "package_number": "string",
  • "tracking_number": "string"
}

Remove a package from a goods in draft

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

goods-in-draft-package-id
required
string

ID of the goods in draft package

Responses

204

Package 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-drafts/{goods-in-draft-id}/packages/{goods-in-draft-package-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-drafts/{goods-in-draft-id}/packages/{goods-in-draft-package-id}

Response samples

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

Goods In Drafts: Origins

Load all origins for the given goods in draft

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

Responses

200

origins are successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/goods-in-drafts/{goods-in-draft-id}/origins

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-drafts/{goods-in-draft-id}/origins

Response samples

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

Add a new origin to a goods in draft

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

Request Body schema: application/json
idempotency_key
string 24 characters

An idempotency key that can be used as part of the calls to create origins (POST /org/{org-id}/goods-in-drafts/{goods-in-draft-id}/origins) to ensure no duplicate origins get created.

The key must be a valid MongoDB ObjectID in lowercase hexadecimal string form.

When present, the enfore platform will check if an origin with the specified key already exists in the goods-in draft:

  • If no such origin exists, the new origin is created normally.
  • If such an origin exists and matches the origin from the POST request, the API does not create a new item but returns a 200 OK response.
  • If such an origin exists but does not match the origin from the POST request, the API call will fail with a 409 CONFLICT and a suitable Problem.

When not present, the origin will be created normally.

type
required
string (GoodsInOriginType)
Enum: "EXTERNAL_GOODS_PROCUREMENT" "EXTERNAL_INVENTORY_SHIPMENT" "EXTERNAL_SALES_RETURN" "GOODS_PROCUREMENT" "INVENTORY_SHIPMENT" "SALES_RETURN"
reference_id
string [ 1 .. 256 ] characters

The ID of the enfore platform object representing the origin business process. When the origin process is not represented in the enfore platform, this is null/omitted.

number
string

A human readable number sourced from the origin busines process.

external_reference
string

A reference to the originating business process in an external system.

date
string <date-time>

The data of the originating business process that is most relevant for the GoodsIn.

For a goods procurement, this is the date of ordering. For all other origin types, this is currently not used.

Responses

200

origin is successfully created.

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

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-drafts/{goods-in-draft-id}/origins

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-drafts/{goods-in-draft-id}/origins

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "idempotency_key": "6526b14b6296fe5a452eb156",
  • "type": "EXTERNAL_GOODS_PROCUREMENT",
  • "reference_id": "string",
  • "number": "string",
  • "external_reference": "string",
  • "date": "2025-03-25T13:45:27Z"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "idempotency_key": "6526b14b6296fe5a452eb156",
  • "type": "EXTERNAL_GOODS_PROCUREMENT",
  • "reference_id": "string",
  • "number": "string",
  • "external_reference": "string",
  • "date": "2025-03-25T13:45:27Z"
}

Load a origin of a goods in draft.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

goods-in-origin-id
required
string

ID of the goods in origin

Responses

200

Origin is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/goods-in-drafts/{goods-in-draft-id}/origins/{goods-in-origin-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-drafts/{goods-in-draft-id}/origins/{goods-in-origin-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "idempotency_key": "6526b14b6296fe5a452eb156",
  • "type": "EXTERNAL_GOODS_PROCUREMENT",
  • "reference_id": "string",
  • "number": "string",
  • "external_reference": "string",
  • "date": "2025-03-25T13:45:27Z"
}

Update a origin of a goods in draft.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

goods-in-origin-id
required
string

ID of the goods in origin

Request Body schema: application/json
idempotency_key
string 24 characters

An idempotency key that can be used as part of the calls to create origins (POST /org/{org-id}/goods-in-drafts/{goods-in-draft-id}/origins) to ensure no duplicate origins get created.

The key must be a valid MongoDB ObjectID in lowercase hexadecimal string form.

When present, the enfore platform will check if an origin with the specified key already exists in the goods-in draft:

  • If no such origin exists, the new origin is created normally.
  • If such an origin exists and matches the origin from the POST request, the API does not create a new item but returns a 200 OK response.
  • If such an origin exists but does not match the origin from the POST request, the API call will fail with a 409 CONFLICT and a suitable Problem.

When not present, the origin will be created normally.

type
required
string (GoodsInOriginType)
Enum: "EXTERNAL_GOODS_PROCUREMENT" "EXTERNAL_INVENTORY_SHIPMENT" "EXTERNAL_SALES_RETURN" "GOODS_PROCUREMENT" "INVENTORY_SHIPMENT" "SALES_RETURN"
reference_id
string [ 1 .. 256 ] characters

The ID of the enfore platform object representing the origin business process. When the origin process is not represented in the enfore platform, this is null/omitted.

number
string

A human readable number sourced from the origin busines process.

external_reference
string

A reference to the originating business process in an external system.

date
string <date-time>

The data of the originating business process that is most relevant for the GoodsIn.

For a goods procurement, this is the date of ordering. For all other origin types, this is currently not used.

Responses

200

Origin 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}/goods-in-drafts/{goods-in-draft-id}/origins/{goods-in-origin-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-drafts/{goods-in-draft-id}/origins/{goods-in-origin-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "idempotency_key": "6526b14b6296fe5a452eb156",
  • "type": "EXTERNAL_GOODS_PROCUREMENT",
  • "reference_id": "string",
  • "number": "string",
  • "external_reference": "string",
  • "date": "2025-03-25T13:45:27Z"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "idempotency_key": "6526b14b6296fe5a452eb156",
  • "type": "EXTERNAL_GOODS_PROCUREMENT",
  • "reference_id": "string",
  • "number": "string",
  • "external_reference": "string",
  • "date": "2025-03-25T13:45:27Z"
}

Remove a origin from a goods in draft

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

goods-in-origin-id
required
string

ID of the goods in origin

Responses

204

Origin 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-drafts/{goods-in-draft-id}/origins/{goods-in-origin-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-drafts/{goods-in-draft-id}/origins/{goods-in-origin-id}

Response samples

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

Goods In Drafts: References

Load all external references for the given goods in draft

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

Responses

200

External references are successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/goods-in-drafts/{goods-in-draft-id}/external-references

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-drafts/{goods-in-draft-id}/external-references

Response samples

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

Add a new external reference to a goods in draft

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

Request Body schema: application/json
type
required
string (GoodsInExternalReferenceType)
Enum: "GOODS_IN" "DELIVERY_NOTE_NUMBER" "OTHER"

The list of types for external references that can be added to goods-in objects.

  • GOODS_IN
    The reference points to a representation of the goods-in in an external system.
  • DELIVERY_NOTE_NUMBER
    The reference points to delivery note for the goods-in in an external system.
  • OTHER
    Indicates a reference of a type not known to the enfore platform.
identifier
required
string [ 1 .. 48 ] characters

The identifier of the referenced object in the external system.

label
object (LocalizedString)

Holds a text that is optionally localized to different languages.

note
string [ 1 .. 256 ] characters

An optional note attached to the external reference.

Responses

200

External reference is 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}/goods-in-drafts/{goods-in-draft-id}/external-references

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-drafts/{goods-in-draft-id}/external-references

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "type": "GOODS_IN",
  • "identifier": "string",
  • "label":
    {
    },
  • "note": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "type": "GOODS_IN",
  • "identifier": "string",
  • "label":
    {
    },
  • "note": "string",
  • "added_on": "2025-03-25T13:45:27Z",
  • "added_by_staff_member_id": "string",
  • "added_from_device_id": "string"
}

Load an external reference of a goods in draft.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

reference-id
required
string

ID of the reference

Responses

200

External reference is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/goods-in-drafts/{goods-in-draft-id}/external-references/{reference-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-drafts/{goods-in-draft-id}/external-references/{reference-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "type": "GOODS_IN",
  • "identifier": "string",
  • "label":
    {
    },
  • "note": "string",
  • "added_on": "2025-03-25T13:45:27Z",
  • "added_by_staff_member_id": "string",
  • "added_from_device_id": "string"
}

Update an external reference of a goods in draft.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

reference-id
required
string

ID of the reference

Request Body schema: application/json
type
required
string (GoodsInExternalReferenceType)
Enum: "GOODS_IN" "DELIVERY_NOTE_NUMBER" "OTHER"

The list of types for external references that can be added to goods-in objects.

  • GOODS_IN
    The reference points to a representation of the goods-in in an external system.
  • DELIVERY_NOTE_NUMBER
    The reference points to delivery note for the goods-in in an external system.
  • OTHER
    Indicates a reference of a type not known to the enfore platform.
identifier
required
string [ 1 .. 48 ] characters

The identifier of the referenced object in the external system.

label
object (LocalizedString)

Holds a text that is optionally localized to different languages.

note
string [ 1 .. 256 ] characters

An optional note attached to the external reference.

Responses

200

External reference 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}/goods-in-drafts/{goods-in-draft-id}/external-references/{reference-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-drafts/{goods-in-draft-id}/external-references/{reference-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "type": "GOODS_IN",
  • "identifier": "string",
  • "label":
    {
    },
  • "note": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "type": "GOODS_IN",
  • "identifier": "string",
  • "label":
    {
    },
  • "note": "string",
  • "added_on": "2025-03-25T13:45:28Z",
  • "added_by_staff_member_id": "string",
  • "added_from_device_id": "string"
}

Remove an external reference from a goods in draft

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

reference-id
required
string

ID of the reference

Responses

204

External reference 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-drafts/{goods-in-draft-id}/external-references/{reference-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-drafts/{goods-in-draft-id}/external-references/{reference-id}

Response samples

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

Goods Ins

Returns goods ins

Returns goods ins for the specified interval, sorted in ascending order by created date and time.

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. 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

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.

number
string

When specified, only goods outs with the specified number are returned.

status
Array of strings (GoodsInStatus)
Items Enum: "IN_CREATION" "PLANNED" "IN_PROCESS" "COMPLETED" "CANCELED" "REJECTED"

When specified, only goods outs with one of the specified status values 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}/goods-ins

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-ins

Response samples

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

Create a new goods in (from a goods in draft)

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json

The quoted ID of the goods in draft that is to be converted to a goods in

string

Responses

200

Goods in is 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}/goods-ins

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-ins

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "number": "string",
  • "delivery_note_number": "string",
  • "sender":
    {
    },
  • "processing_service_location_id": "string",
  • "processing_location_id": "string",
  • "responsible_staff_id": "string",
  • "assigned_staff_id": "string",
  • "status": "IN_CREATION",
  • "status_log":
    [
    ],
  • "receipt_started": true,
  • "receipt_completed": true,
  • "review_started": true,
  • "review_completed": true,
  • "is_in_resolution": true,
  • "kpis":
    {
    },
  • "note": "string",
  • "advised_delivery_timespan":
    {
    },
  • "expected_package_count": 0,
  • "is_controlled_by_system": true,
  • "external_data": "string"
}

Load a goods in by its identifier

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-id
required
string

ID of the goods in

Responses

200

Goods in 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-ins/{goods-in-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-ins/{goods-in-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "number": "string",
  • "delivery_note_number": "string",
  • "sender":
    {
    },
  • "processing_service_location_id": "string",
  • "processing_location_id": "string",
  • "responsible_staff_id": "string",
  • "assigned_staff_id": "string",
  • "status": "IN_CREATION",
  • "status_log":
    [
    ],
  • "receipt_started": true,
  • "receipt_completed": true,
  • "review_started": true,
  • "review_completed": true,
  • "is_in_resolution": true,
  • "kpis":
    {
    },
  • "note": "string",
  • "advised_delivery_timespan":
    {
    },
  • "expected_package_count": 0,
  • "is_controlled_by_system": true,
  • "external_data": "string"
}

Update a goods in

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-id
required
string

ID of the goods in

Request Body schema: application/json
@type
required
string
Default: "GoodsInUpdateExternalDataRequest"
GoodsInUpdateExternalDataRequest
external_data
string <= 256 characters

The new external data to associate with the goods-in.

Providing this field will replace any existing external data with the value provided. Omitting this field will cause the deletion of any existing external data.

Responses

200

Goods in 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.

patch/org/{org-id}/goods-ins/{goods-in-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-ins/{goods-in-id}

Request samples

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

Response samples

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

Goods Ins: Items

Iterate over the items of a goods in.

Returns items of the specified goods in, sorted in ascending order by creation order date and time.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-id
required
string

ID of the goods in

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

422

Specified data is semantically incorrect.

get/org/{org-id}/goods-ins/{goods-in-id}/items

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-ins/{goods-in-id}/items

Response samples

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

Load an item of a goods in.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-id
required
string

ID of the goods in

item-id
required
string

ID of the goods in item

Responses

200

Item is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/goods-ins/{goods-in-id}/items/{item-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-ins/{goods-in-id}/items/{item-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "product_id": "string",
  • "primary_product_identifier":
    {
    },
  • "secondary_product_identifier":
    {
    },
  • "unit":
    {
    },
  • "custom_unit_id": "string",
  • "expected_number_of_units": 0,
  • "expected_unique_item_identifiers":
    {
    },
  • "expected_lot_id": "string",
  • "expected_condition_id": "string",
  • "expected_values_change_log":
    [
    ],
  • "original_expected_number_of_units": 0,
  • "original_expected_unique_item_identifiers":
    {
    },
  • "original_expected_lot_id": "string",
  • "original_expected_condition_id": "string",
  • "received_number_of_units": 0,
  • "received_unique_item_identifiers":
    {
    },
  • "received_lot_id": "string",
  • "received_condition_id": "string",
  • "receiving_storage_location_id": "string",
  • "storage_location_compatibility_waiver":
    {
    },
  • "received_values_change_log":
    [
    ],
  • "is_reviewed": false,
  • "missing_received_values_waivers":
    [
    ],
  • "resolutions":
    [
    ],
  • "resolved_number_of_units": 0,
  • "planned_resolved_number_of_units": 0,
  • "origin_id": "string",
  • "package_id": "string",
  • "note": "string",
  • "position_identifier": "string",
  • "sort_value": "",
  • "group_value":
    {
    },
  • "is_controlled_by_system": true,
  • "external_data": "string",
  • "derived_from":
    [
    ],
  • "is_derived_item": false
}

Update an item of a goods in

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-id
required
string

ID of the goods in

item-id
required
string

ID of the goods in item

Request Body schema: application/json
@type
required
string
Default: "GoodsInItemUpdateExternalDataRequest"
GoodsInItemUpdateExternalDataRequest
external_data
string <= 256 characters

The new external data to associate with the goods-in item.

Providing this field will replace any existing external data with the value provided. Omitting this field will cause the deletion of any existing external data.

Responses

200

Goods in item 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.

patch/org/{org-id}/goods-ins/{goods-in-id}/items/{item-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-ins/{goods-in-id}/items/{item-id}

Request samples

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

Response samples

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

Goods Ins: Packages

Load all packages for the given goods-in

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-id
required
string

ID of the goods in

Responses

200

packages 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}/goods-ins/{goods-in-id}/packages

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-ins/{goods-in-id}/packages

Response samples

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

Load a package of a goods in.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-id
required
string

ID of the goods in

goods-in-package-id
required
string

ID of the goods in package

Responses

200

Package is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/goods-ins/{goods-in-id}/packages/{goods-in-package-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-ins/{goods-in-id}/packages/{goods-in-package-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "package_number": "string",
  • "tracking_number": "string",
  • "received_on": "2025-03-25T13:45:28Z",
  • "status": "ADVISED",
  • "status_log":
    [
    ],
  • "kpis":
    {
    }
}

Goods Ins: Origins

Load all origins for the given goods-in

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-id
required
string

ID of the goods in

Responses

200

origins 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}/goods-ins/{goods-in-id}/origins

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-ins/{goods-in-id}/origins

Response samples

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

Load a origin of a goods in.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-id
required
string

ID of the goods in

goods-in-origin-id
required
string

ID of the goods in origin

Responses

200

Origin is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/goods-ins/{goods-in-id}/origins/{goods-in-origin-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-ins/{goods-in-id}/origins/{goods-in-origin-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "idempotency_key": "6526b14b6296fe5a452eb156",
  • "type": "EXTERNAL_GOODS_PROCUREMENT",
  • "reference_id": "string",
  • "number": "string",
  • "external_reference": "string",
  • "date": "2025-03-25T13:45:28Z"
}

Goods Ins: References

Load all external references for the given goods-in

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-id
required
string

ID of the goods in

Responses

200

External references 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}/goods-ins/{goods-in-id}/external-references

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-ins/{goods-in-id}/external-references

Response samples

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

Load an external reference of a goods in.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-id
required
string

ID of the goods in

reference-id
required
string

ID of the reference

Responses

200

External reference is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/goods-ins/{goods-in-id}/external-references/{reference-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-ins/{goods-in-id}/external-references/{reference-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "type": "GOODS_IN",
  • "identifier": "string",
  • "label":
    {
    },
  • "note": "string",
  • "added_on": "2025-03-25T13:45:28Z",
  • "added_by_staff_member_id": "string",
  • "added_from_device_id": "string"
}

Goods Ins: Subscriptions

Get a list of registered consumers for goods in 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}/goods-in-subscriptions

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-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}/goods-in-subscriptions

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-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 goods ins

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}/goods-in-subscriptions/{subscription-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-subscriptions/{subscription-id}

Response samples

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

Get a list of registered consumers for goods in item 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}/goods-in-item-subscriptions

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-item-subscriptions

Response samples

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

Register an event consumer with the API.

If the same consumer (callback_url) is already registered with the same filter (only_for_goods_in_with_status), no new registation is created. Instead, 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.

filter
object (GoodsInItemEventSubscriptionFilter)

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}/goods-in-item-subscriptions

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-item-subscriptions

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "callback_url": "https://myserver.com/send/events/here",
  • "public_key": "string",
  • "filter":
    {
    }
}

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 goods in items

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}/goods-in-item-subscriptions/{subscription-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/goods-in-item-subscriptions/{subscription-id}

Response samples

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

Stock-Taking

Query stock-takings (enforePOS1)

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
from
string <date-time>

Limits the results to stock-takings with an end_time_stock_taking timestamp greater than or equal to this parameter.

Note that stock-takings that do not have finished counting yet do not have an end_time_stock_taking and thus are not included in the query.

Timestamp in UTC. The date-time notation as defined by RFC 3339, section 5.6, with the "Z" as time-offset. For example, 2017-07-21T17:32:28.123Z

to
string <date-time>

Limits the results to stock-takings with an end_time_stock_taking timestamp less than this parameter.

Note that stock-takings that do not have finished counting yet do not have an end_time_stock_taking and thus are not included in the query.

Timestamp in UTC. The date-time notation as defined by RFC 3339, 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

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.

status
string (StockTakingStatus)
Enum: "IN_PREPARATION" "IN_PROGRESS" "COMPLETED" "COMPLETED_RECONCILIATION" "CANCELED"

When specified, only stock-takings with the specified status are returned.

storage_location_id
string [ 1 .. 256 ] characters

When specified, only stock-takings for the specified storage location are returned.

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}/stock-takings-enfore-pos-1

Production

https://external.apis.enfore.com/inventory/org/{org-id}/stock-takings-enfore-pos-1

Response samples

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

Load single stock-taking (enforePOS1)

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

stock-taking-id
required
string

ID of the stock-taking

Responses

200

Data 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}/stock-takings-enfore-pos-1/{stock-taking-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/stock-takings-enfore-pos-1/{stock-taking-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "storage_location_id": "string",
  • "number": "string",
  • "description": "string",
  • "status": "IN_PREPARATION",
  • "settings":
    {
    },
  • "timestamps":
    {
    },
  • "kpis":
    {
    }
}

Query data exports for stock-takings

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.

stock_taking_kind
required
string (StockTakingKind)
Value: "ENFOREPOS1"

When specified together with stock_taking_id, only exports for the specified stock-taking are returned.

stock_taking_id
required
string [ 1 .. 256 ] characters

When specified together with stock_taking_kind, only exports for the specified stock-taking are returned.

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}/stock-taking-exports

Production

https://external.apis.enfore.com/inventory/org/{org-id}/stock-taking-exports

Response samples

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

Create new stock-taking data export

Note that exports can only be created for stock-takings that have reached a terminal state. That is, COMPLETED, COMPLETED_RECONCILIATION, and CANCELED.

Trying to trigger an export for a stock-taking in any other state will fail with 422 Unprocessable Entity.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json

The reference (id + version) of the stock-taking whose data is to be exported

stock_taking_kind
required
string (StockTakingKind)
Value: "ENFOREPOS1"
stock_taking_id
required
string [ 1 .. 256 ] characters

Responses

200

Data export 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}/stock-taking-exports

Production

https://external.apis.enfore.com/inventory/org/{org-id}/stock-taking-exports

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "stock_taking_kind": "ENFOREPOS1",
  • "stock_taking_id": "string"
}

Response samples

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

Load single stock-taking data export

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

export-id
required
string

ID of the data export

Responses

200

Data 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}/stock-taking-exports/{export-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/stock-taking-exports/{export-id}

Response samples

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

Retrieve download url for data export

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

export-id
required
string

ID of the data export

Responses

200

The download url that was requested

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/stock-taking-exports/{export-id}/download

Production

https://external.apis.enfore.com/inventory/org/{org-id}/stock-taking-exports/{export-id}/download

Response samples

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

Manual Stock Modifications

Returns manual stock modifications

Returns manual stock modifications for the specified interval, sorted in ascending order by created date and time.

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. 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

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}/manual-stock-modifications

Production

https://external.apis.enfore.com/inventory/org/{org-id}/manual-stock-modifications

Response samples

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

Load a manual stock modification by its identifier

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

msm-id
required
string

ID of the manual stock modification

Responses

200

Manual stock modification 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-modifications/{msm-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/manual-stock-modifications/{msm-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "recorded_for":
    {
    },
  • "status": "PENDING",
  • "status_log":
    [
    ]
}

Load a manual stock modification including its subresources

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

msm-id
required
string

ID of the manual stock modification

Responses

200

Manual stock modification and subresources 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}/manual-stock-modifications/{msm-id}/full

Production

https://external.apis.enfore.com/inventory/org/{org-id}/manual-stock-modifications/{msm-id}/full

Response samples

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

Manual Stock Modifications: Operations

Iterate over the operations of a manual stock modification.

Returns operations of the specified manual stock modification, sorted in ascending order by creation order date and time.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

msm-id
required
string

ID of the manual stock modification

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

422

Specified data is semantically incorrect.

get/org/{org-id}/manual-stock-modifications/{msm-id}/operations

Production

https://external.apis.enfore.com/inventory/org/{org-id}/manual-stock-modifications/{msm-id}/operations

Response samples

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

Load an operation of a manual stock modification.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

msm-id
required
string

ID of the manual stock modification

operation-id
required
string

ID of the operation

Responses

200

Operation is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/manual-stock-modifications/{msm-id}/operations/{operation-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/manual-stock-modifications/{msm-id}/operations/{operation-id}

Response samples

Content type
application/json
Example
StockCountResetOperation
Copy
 Expand all Collapse all
{
  • "@type": "StockCountResetOperation",
  • "id": "string",
  • "status": "PENDING",
  • "status_log":
    [
    ],
  • "failure_reason": "INVALID_RESOURCE",
  • "undone_by":
    {
    },
  • "reason":
    {
    },
  • "storage_location_id": "string",
  • "storage_area_id": "string",
  • "storage_location_compatibility_waiver":
    {
    },
  • "product_id": "string",
  • "lot_id": "string",
  • "condition_id": "string",
  • "number_of_tracking_units": 0,
  • "custom_unit_id": "string",
  • "custom_unit_size":
    {
    }
}

Signatures

Get data about a signature

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

signature-id
required
string

ID of the signature

Responses

200

Signature data is returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

get/org/{org-id}/signatures/{signature-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/signatures/{signature-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "signature_of":
    {
    },
  • "recorded_on": "2025-03-25T13:45:30Z",
  • "recorded_by_staff_member_id": "string",
  • "recorded_with_device_id": "string"
}

Get a download URL for the image binary of a signature

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

signature-id
required
string

ID of the signature

Responses

200

The download url that was requested

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/signatures/{signature-id}/download

Production

https://external.apis.enfore.com/inventory/org/{org-id}/signatures/{signature-id}/download

Response samples

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

Deprecated Stock Count Changes

Get a list of registered consumers for stock count changes events. Deprecated

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.

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/stock-count-changes/subscriptions

Production

https://external.apis.enfore.com/inventory/org/{org-id}/stock-count-changes/subscriptions

Response samples

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

Register an event consumer with the API. Deprecated

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 and remove the subscription after 30 minutes of persistent failure.

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}/stock-count-changes/subscriptions

Production

https://external.apis.enfore.com/inventory/org/{org-id}/stock-count-changes/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 stock count changes 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}/stock-count-changes/subscriptions/{subscription-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/stock-count-changes/subscriptions/{subscription-id}

Response samples

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

Iterate over stock count changes. Deprecated

Returns stock count changes, sorted in ascending order by "effective_on" date and time. This is depcrecated. use stock-count-changes instead

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. 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

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.

location_id
string

When specified, only stock count changes for the specified location are returned.

product_id
string

When specified, only stock count changes for the specified product are returned.

reason
Array of strings (StockCountChangeReason)
Items Enum: "BROKEN" "BUNDLING" "CORRECTION" "CUSTOM" "DONATED" "INITIAL_COUNT" "INTERNAL_USE" "INVENTORY_TRANSFER" "MANUFACTURED_ASSEMBLED" "OUTDATED" "PRIVATE_USE" "PURCHASE" "PURCHASE_RETURN" "SALE" "SALES_RETURN" "STOLEN" "UNBUNDLING" "UNSPECIFIED" "USED_AS_RAW_MATERIAL"

When specified, only stock count changes with one of the specified reason values 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}/stock_count_changes

Production

https://external.apis.enfore.com/inventory/org/{org-id}/stock_count_changes

Response samples

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

Get a list of registered consumers for stock count changes events. Deprecated

Retrieve all currently active event subscriptions. This is depcrecated. Use stock-count-changes instead.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Responses

200

List of registrations.

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

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

Production

https://external.apis.enfore.com/inventory/org/{org-id}/stock_count_changes/subscriptions

Response samples

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

Register an event consumer with the API. Deprecated

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. This is depcrecated. Use stock-count-changes instead.

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}/stock_count_changes/subscriptions

Production

https://external.apis.enfore.com/inventory/org/{org-id}/stock_count_changes/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
{
  • "items":
    [
    ],
  • "problems":
    []
}

Delete a subscription for GoodsIn changes 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. This is depcrecated. Use stock-count-changes instead.

Responses

204

Subscription was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

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

Production

https://external.apis.enfore.com/inventory/org/{org-id}/stock_count_changes/subscriptions/{subscription-id}

Response samples

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

Deprecated Goods Ins

Iterate over goods in drafts. Deprecated

Returns goods in drafts, sorted in ascending order by creation order date and time.

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. 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

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.

destination_storage_location_id
string

When specified, only goods in drafts with the specified location as destination 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}/deprecated/goods-in-drafts

Production

https://external.apis.enfore.com/inventory/org/{org-id}/deprecated/goods-in-drafts

Response samples

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

Create a new goods in draft Deprecated

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
parent_information
required
object (DeprecatedGoodsInDraftParentInformation)

Information about the parent of the goods in.

destination_storage_location
required
string

The ID of the storage location to which stock is to be transferred.

description
string <= 1024 characters

A descriptive text for the goods in that can freely be set by the client.

responsible_staff
string [ 1 .. 100 ] characters

The ID of the individual contact representing the staff member responsible for the goods in.

Responses

200

Goods in draft is 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}/deprecated/goods-in-drafts

Production

https://external.apis.enfore.com/inventory/org/{org-id}/deprecated/goods-in-drafts

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "parent_information":
    {
    },
  • "destination_storage_location": "string",
  • "description": "string",
  • "responsible_staff": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "parent_information":
    {
    },
  • "destination_storage_location": "string",
  • "description": "string",
  • "responsible_staff": "string"
}

Load a goods in draft by its identifier. Deprecated

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

Responses

200

Goods in draft 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}/deprecated/goods-in-drafts/{goods-in-draft-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/deprecated/goods-in-drafts/{goods-in-draft-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "parent_information":
    {
    },
  • "destination_storage_location": "string",
  • "description": "string",
  • "responsible_staff": "string"
}

Delete a goods in draft Deprecated

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

Responses

204

Goods in draft was successfully deleted.

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/deprecated/goods-in-drafts/{goods-in-draft-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/deprecated/goods-in-drafts/{goods-in-draft-id}

Response samples

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

Returns goods ins Deprecated

Returns goods ins for the specified interval, sorted in ascending order by order date and time.

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. 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

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.

destination_storage_location_id
string

When specified, only goods ins with the specified location as description location are returned.

number
string

When specified, only goods ins with the specified number are returned.

status
Array of strings (DeprecatedGoodsInStatus)
Items Enum: "PENDING" "RECEIVED" "CANCELED"

When specified, only goods ins with one of the specified status values 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}/deprecated/goods-ins

Production

https://external.apis.enfore.com/inventory/org/{org-id}/deprecated/goods-ins

Response samples

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

Create a new goods in (from a goods in draft) Deprecated

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json

The quoted ID of the goods in draft that is to be converted to a goods in

string

Responses

200

Goods in is 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}/deprecated/goods-ins

Production

https://external.apis.enfore.com/inventory/org/{org-id}/deprecated/goods-ins

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "number": "string",
  • "description": "string",
  • "parent_information":
    {
    },
  • "destination_storage_location": "string",
  • "responsible_staff": "stringstringstringst",
  • "updated_by": "string",
  • "updated_on_device": "string",
  • "status": "PENDING",
  • "items":
    [
    ]
}

Load a goods in by its identifier Deprecated

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-id
required
string

ID of the goods in

Responses

200

Goods in 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}/deprecated/goods-ins/{goods-in-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/deprecated/goods-ins/{goods-in-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "number": "string",
  • "description": "string",
  • "parent_information":
    {
    },
  • "destination_storage_location": "string",
  • "responsible_staff": "stringstringstringst",
  • "updated_by": "string",
  • "updated_on_device": "string",
  • "status": "PENDING",
  • "items":
    [
    ]
}

Update the status of a goods in Deprecated

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-id
required
string

ID of the goods in

Request Body schema: text/plain
string (DeprecatedGoodsInStatus)
Enum: "PENDING" "RECEIVED" "CANCELED"

The possible status values for goods ins. See the API documentation for a full explanation of the goods in state machine.

Responses

200

Goods in status 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}/deprecated/goods-ins/{goods-in-id}/status

Production

https://external.apis.enfore.com/inventory/org/{org-id}/deprecated/goods-ins/{goods-in-id}/status

Response samples

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

Deprecated Goods Ins: Items

Iterate over the items of a goods in draft. Deprecated

Returns items of the specified goods in draft, sorted in ascending order by creation order date and time.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/deprecated/goods-in-drafts/{goods-in-draft-id}/items

Production

https://external.apis.enfore.com/inventory/org/{org-id}/deprecated/goods-in-drafts/{goods-in-draft-id}/items

Response samples

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

Add a new item to a goods in draft Deprecated

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

Request Body schema: application/json
product
required
string

The ID of the product that is to be transferred.

lot
string

The ID of the lot that the to be transferred product belong to.

quantity
required
object (Quantity)

A Quantity represents a quantity value (i.e., a unit and an amount), for example "3 pcs" or "2.5 kg".

condition
required
string (StockCondition)
Enum: "NEW" "REFURBISHED" "USED_LIKE_NEW" "USED_VERY_GOOD" "USED_GOOD" "USED_ACCEPTABLE" "DAMAGED"

The possible values for condition of inventor stock.

Responses

200

Item is 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}/deprecated/goods-in-drafts/{goods-in-draft-id}/items

Production

https://external.apis.enfore.com/inventory/org/{org-id}/deprecated/goods-in-drafts/{goods-in-draft-id}/items

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "product": "string",
  • "lot": "string",
  • "quantity":
    {
    },
  • "condition": "NEW"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "product": "string",
  • "lot": "string",
  • "quantity":
    {
    },
  • "condition": "NEW"
}

Load an item of a goods in draft. Deprecated

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

item-id
required
string

ID of the item

Responses

200

Item 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}/deprecated/goods-in-drafts/{goods-in-draft-id}/items/{item-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/deprecated/goods-in-drafts/{goods-in-draft-id}/items/{item-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "product": "string",
  • "lot": "string",
  • "quantity":
    {
    },
  • "condition": "NEW"
}

Update an item of a goods in draft. Deprecated

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

item-id
required
string

ID of the item

Request Body schema: application/json
product
required
string

The ID of the product that is to be transferred.

lot
string

The ID of the lot that the to be transferred product belong to.

quantity
required
object (Quantity)

A Quantity represents a quantity value (i.e., a unit and an amount), for example "3 pcs" or "2.5 kg".

condition
required
string (StockCondition)
Enum: "NEW" "REFURBISHED" "USED_LIKE_NEW" "USED_VERY_GOOD" "USED_GOOD" "USED_ACCEPTABLE" "DAMAGED"

The possible values for condition of inventor stock.

Responses

200

Item 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}/deprecated/goods-in-drafts/{goods-in-draft-id}/items/{item-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/deprecated/goods-in-drafts/{goods-in-draft-id}/items/{item-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "product": "string",
  • "lot": "string",
  • "quantity":
    {
    },
  • "condition": "NEW"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "product": "string",
  • "lot": "string",
  • "quantity":
    {
    },
  • "condition": "NEW"
}

Remove an item from a goods in draft Deprecated

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

goods-in-draft-id
required
string

ID of the goods in draft

item-id
required
string

ID of the item

Responses

204

Item was successfully deleted.

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/deprecated/goods-in-drafts/{goods-in-draft-id}/items/{item-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/deprecated/goods-in-drafts/{goods-in-draft-id}/items/{item-id}

Response samples

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

Deprecated Goods Ins: Subscriptions

Register an event consumer with the API. Deprecated

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}/deprecated/goods-ins-subscriptions

Production

https://external.apis.enfore.com/inventory/org/{org-id}/deprecated/goods-ins-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 goods-in changes 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}/deprecated/goods-ins-subscriptions/{subscription-id}

Production

https://external.apis.enfore.com/inventory/org/{org-id}/deprecated/goods-ins-subscriptions/{subscription-id}

Response samples

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