Edara API v3: Bundles

Read the guide first: authentication, paging, errors, rate limits and the shared PagedResult, BatchResult and *Reference shapes.

• GET /v3/bundles: Lists bundles.
• GET /v3/bundles/{id}: Gets a bundle by id.
• POST /v3/bundles: Creates a bundle.
• DELETE /v3/bundles/{id}: Deletes a bundle.

Endpoints

GET /v3/bundles: Lists bundles.

Operation GetBundles · permission read:bundle

Query string: GetBundlesQuery

Responses: OK PagedResult<BundleResponse>: Paged list of bundles.

Notes

• updateDate is the only filter. It returns bundles created or updated strictly after that time, and without it you get every bundle.
• Inactive bundles are included, because there is no filter on active status. Results are ordered by id.
• When nothing matches, you get 200 with an empty list, not 404.
• When you page past the last bundle, totalCount comes back as 0, so do not read the total from an empty page.
• Every bundle comes back with its full bundleDetails, including each line's taxRate and tax, so large pages are slow.
• A line whose stock item no longer exists is left out of bundleDetails.

GET /v3/bundles/{id}: Gets a bundle by id.

Operation GetBundleById · permission read:bundle

Parameters

Responses: OK BundleResponse: The bundle.

Notes

• Inactive bundles are returned too. An id that does not exist gives 404.
• Lines are returned in the order of their line id. Each line carries a stockItem reference and a unitOfMeasure reference.
• taxRate and tax on each line are the stock item's current values. They are not stored on the bundle, so they can change between calls.

POST /v3/bundles: Creates a bundle.

Operation CreateBundle · permission create:bundle

Body: CreateBundleRequest

Responses: Created BundleResponse: Bundle created.

Business errors (HTTP 409, match on errorCode):

• DupplicatedName: Another bundle already uses the same description.

Notes

• The combined length of all tags must be at most 4000 characters.
• Each stockItemId only has to exist. If any does not, you get 400 with a message that lists the missing ids.
• unitOfMeasureId only has to be an existing unit of measure, and one that does not exist gives 400. The API does not check that it belongs to the stock item's units of measure, so check that yourself.
• The same stock item can appear on more than one line, and price is not checked against unitPrice times quantity. Prices are stored exactly as you send them.
• A new bundle is always created with isActive true. A missing dimensionsValue is stored as 0 and a missing dimensions as an empty string.
• Line breaks and tabs are removed from notes before saving.
• The bundle and all its lines are saved together. If anything fails, nothing is created.
• A description already used by any bundle, active or inactive, gives 409 with errorCode DupplicatedName. Note the spelling of the value.
• Success returns 201 with the bundle as it was stored, including the values the server set.

DELETE /v3/bundles/{id}: Deletes a bundle.

Operation DeleteBundleById · permission delete:bundle

Parameters

Responses: NoContent: (not declared; read from the method body)

Business errors (HTTP 409, match on errorCode):

• ItemCannotDeleteItInUse: The bundle is referenced by existing documents or related records.

Notes

• This permanently deletes the bundle and its lines. Success returns 204, and an id that does not exist returns 404.
• A bundle used on any sales document cannot be deleted. You get 409 with errorCode ItemCannotDeleteItInUse and an empty message, and the bundle is left unchanged.

Types

BundleItemResponse

Response describing a bundle line item.

BundleResponse

Response describing a bundle.

CreateBundleItemRequest

Request to create a bundle line item.

StockItemReference

Lightweight stock-item reference (id + code + description).

TaxReference

Lightweight tax reference (id + name + rate).

UnitOfMeasureReference

Lightweight unit-of-measure reference (id + name).