Developer documentation

Inbounds

Use the Inbounds API to create, retrieve, and update inbounds. This page describes the models (inbound, inbound lines, metadata) and endpoints to manage inbound receipts.

Inbounds are used to determine what goods / articles are brought into the warehouse.

Response models

These response models describe the objects returned by this resource.

The inbound model

Field	Description
`id` stringOptional	Read-only. Unique identifier for the inbound.
`customer` uuidOptional	-
`is_return` boolOptional	-
`created_at` datetimeOptional	Read-only.
`reference` stringOptional	Read-only.

The inbound line model

Field	Description
`variant` VariantOptional	-
`quantity` integerOptional	-
`processed` integerOptional	-
`packing_slip` integerOptional	-
`meta_data` arrayOptional	An object of key-value pairs. Retrieve all available metadata that are associated with this inbound line. Metadata is a valuable tool for making your inbound management more flexible and insightful. Metadata allows you to customize your inbound line data to suit your unique business requirements.

The meta data model

Meta data is available for both inbound and inbound lines. Make sure you add 'meta_data' within the expand header New to the Expand header? See how it works, available groups, and request examples: [Expanding responses](/expanding-responses). We will throw an error when identical inbound lines are being merged and each line consists of meta_data

Field	Description
`{key: value}` objectOptional	An object of key-value pairs.

List all inbounds

GET/wms/inbounds/

Retrieves a collection of inbounds

Try it

Send a live request against the development middleware using your current API test session.

GET

Request attributes

Field	Description
`reference` stringOptional	Search for a specific reference.
`status` stringOptional	Search for a specific status.
`type` stringOptional	Search for a specific type. Options: `import`, `announced`, or `unannounced`.
`limit` integerOptional	Limit the number of results. Default is 50.
`page` integerOptional	The page number to retrieve.
`direction` stringOptional	Sort direction. Options: `asc` or `desc`. Default is `desc`.
`sort` stringOptional	Sort field. Options: `createdAt`, `status`, `modifiedAt`, or `inboundDate`. Default is `inboundDate`.

Request examplecURL

curl https://eu-dev.middleware.ewarehousing-solutions.com/wms/inbounds/

Response exampleJSON

[
  {
    "id": "15dca9c4-eed3-452f-8bfb-015aefb45f6b",
    "customer": "53b5a543-129a-403c-9a6e-3d9c525ffa5b",
    "created_at": "2022-07-07T17:03:27+00:00",
    "reference": "INB00000000001",
    "external_reference": "INITIAL_STOCK_2022-07-07 17:03:27.99067+02",
    "status": "completed",
    "inbound_date": "2022-07-07T17:03:28+00:00",
    "note": null
  },
  {
    "id": "a531b110-48f4-410a-98f8-053051130016",
    "customer": "53b5a543-129a-403c-9a6e-3d9c525ffa5b",
    "created_at": "2022-07-07T17:03:27+00:00",
    "reference": "INB00000000002",
    "external_reference": "INITIAL_STOCK_2016-11-23-09-05-02a",
    "status": "completed",
    "inbound_date": "2022-07-07T17:03:28+00:00",
    "note": null
  }
]

Retrieve an inbound

GET/wms/inbounds/:id/

Retrieve a single inbound.

Try it

Send a live request against the development middleware using your current API test session.

GET

Path parameters

Request examplecURL

curl https://eu-dev.middleware.ewarehousing-solutions.com/wms/inbounds/e710389a-5505-49d4-9b99-8314f3543427

Response exampleJSON

{
  "id": "03ed9a0a-812a-42e2-b622-f0fd7fc9e906",
  "customer": "53b5a543-129a-403c-9a6e-3d9c525ffa5b",
  "created_at": "2022-07-07T17:03:27+00:00",
  "reference": "INB00000000001",
  "external_reference": "INITIAL_STOCK_2022-07-07 17:03:27.99067+02",
  "status": "completed",
  "inbound_date": "2022-07-07T17:03:28+00:00",
  "note": null,
  "inbound_lines": [
    {
      "variant": {
        "id": "108af557-3614-42fa-8bd5-7662e47e1927",
        "article_code": "6047",
        "name": "6047",
        "description": null,
        "ean": "6047",
        "sku": null,
        "hs_tariff_code": null,
        "height": null,
        "depth": null,
        "width": null,
        "weight": null,
        "expirable": false,
        "country_of_origin": null,
        "using_serial_numbers": false,
        "value": 0
      },
      "quantity": 30,
      "processed": null,
      "packing_slip": 30
    }
  ]
}

Create an inbound

POST/wms/inbounds/

This endpoint allows you to add a new inbound

Try it

Send a live request against the development middleware using your current API test session.

POST

Request attributes

Field	Description	Example value
`external_reference` stringRequired	External reference for the inbound.
`inbound_lines` array of inbound linesRequired	Lines that will be received.	Not editable here
`inbound_date` dateRequired	Planned inbound date.
`meta_data` arrayOptional	Additional metadata key-value pairs.	Not editable here

Request examplecURL

curl -X POST 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/inbounds/' \
            -H 'Content-Type: application/json' \
            --data-raw '{
                "external_reference": "1560520952",
                "note": "Priority Inbound",
                "inbound_date": "2018-11-14",
                "inbound_lines": [
                    {
                        "quantity": 30,
                        "packing_slip": 30,
                        "article_code": "VBP_C"
                    },
                    {
                        "quantity": 20,
                        "packing_slip": 30,
                        "article_code": "VBP_B"
                    }
                ]
            }'

Response exampleJSON

{
  "external_reference": "1560520952",
  "note": "Priority Inbound",
  "inbound_date": "2018-11-14",
  "inbound_lines": [
    {
      "quantity": 30,
      "packing_slip": 30,
      "article_code": "VBP_C"
    },
    {
      "quantity": 20,
      "packing_slip": 30,
      "article_code": "VBP_B"
    }
  ]
}

Update an inbound

PATCH/wms/inbounds/:id/

This endpoint allows you to perform an update on an inbound.

Try it

Send a live request against the development middleware using your current API test session.

PATCH

Path parameters

Request examplecURL

curl -X PATCH https://eu-dev.middleware.ewarehousing-solutions.com/wms/inbounds/774bf6ee-90cf-11e9-b36d-0242ac120005/ \
            --data-raw '{
            "note": "Update Note"
        }'

Response exampleJSON

{
  "id": "4fdb3055-4b1d-4352-96d5-2a89f9f50680",
  "customer": "be62c27e-2aac-4ac1-902e-f770d64f8dce",
  "created_at": "2022-10-27T13:14:45+00:00",
  "reference": "INB00000000272",
  "external_reference": "PO-1569",
  "status": "announced",
  "inbound_date": "2022-12-30T00:00:00+00:00",
  "note": "Update Note",
  "inbound_lines": [
    {
      "variant": {
        "id": "5060691c-2812-48e2-bd07-82ff3fd19382"
      },
      "quantity": 30,
      "processed": null,
      "packing_slip": 30
    },
    {
      "variant": {
        "id": "b04f5233-9980-4307-bb20-bc7460b49933"
      },
      "quantity": 20,
      "processed": null,
      "packing_slip": 20
    }
  ]
}

Cancel an inbound

PATCH/wms/inbounds/:id/cancel/

This endpoint allows you to perform cancel an inbound.

Try it

Send a live request against the development middleware using your current API test session.

PATCH

Path parameters

Request examplecURL

curl -X PATCH https://eu-dev.middleware.ewarehousing-solutions.com/wms/inbounds/774bf6ee-90cf-11e9-b36d-0242ac120005/cancel/

List quality controls for inbound

GET/wms/inbounds/:id/quality-controls/

List quality controls for a single inbound.

Try it

Send a live request against the development middleware using your current API test session.

GET

Path parameters

Request examplecURL

curl https://eu-dev.middleware.ewarehousing-solutions.com/wms/inbounds/e710389a-5505-49d4-9b99-8314f3543427

Response exampleJSON

[
  {
    "id": "cac4da93-355a-4ffc-916e-5f3577cbd188",
    "created_at": "2023-07-05T12:54:24+00:00",
    "pallet_count": "150",
    "was_delivery_appointment": true,
    "had_packing_list": true,
    "was_correct_quantity": true,
    "had_proper_markings": true,
    "box_condition": "good",
    "comments": "Everything looked good.",
    "documents": [
      {
        "id": "880b668f-2748-4e18-92e1-5c836cea40f4",
        "title": "dummy.jpeg",
        "mime_type": "image/jpeg",
        "created_at": "2023-07-25T12:30:54+00:00"
      }
    ]
  }
]