transfer_order

Receive Transfer Order

Receive shipping items from the origin warehouse into the destination warehouse.

put/transfer-orders/{id}/receive

Request

Base URL: https://app.zenventory.com/rest
URL: https://app.zenventory.com/rest/transfer-orders/{id}/receive
Auth: none declared

Path parameters

idinteger required

Id of the transfer order.

Request body

locationIdinteger required

Id of the location in the destination warehouse the inventory will be placed in.

locationNameinteger required

Name of the location in the destination warehouse the inventory will be placed in. Ignored if locationId is provided.

receiveLocationIdinteger

Id of the staging location in the destination warehouse the inventory will first be placed in. Only used if staged delivery is enabled in the settings.

receiveLocationNameinteger

Name of the staging location in the destination warehouse the inventory will first be placed in. Only used if staged delivery is enabled in the settings. Ignored if receiveLocationId is provided.

Response

Success

idinteger

draftboolean

completedboolean

requiredBystring date-time

createdDatestring date-time

preparedDatestring date-time

shipViastring

deletedboolean

deletedDatestring date-time

cancelledboolean

cancelledDatestring date-time

cancelledReasonstring

notesstring

Example response

{
  "id": 78,
  "originWarehouse": {
    "id": 1,
    "name": "Main Warehouse"
  },
  "destinationWarehouse": {
    "id": 2,
    "name": "Second Warehouse"
  },
  "draft": false,
  "completed": false,
  "requiredBy": "2023-07-30T12:00:00-07:00",
  "createdDate": "2023-07-26T16:36:47-07:00",
  "preparedBy": {
    "id": 1,
    "name": "Mr Sparks"
  },
  "preparedDate": "2023-07-26T17:23:18-07:00",
  "shipVia": "fedex_ground",
  "deleted": false,
  "deletedBy": null,
  "deletedDate": "",
  "cancelled": false,
  "cancelledBy": null,
  "cancelledDate": "",
  "cancelledReason": "",
  "notes": "Monthly transfer",
  "tags": [],
  "items": [
    {
      "id": 96,
      "itemId": 2330,
      "sku": "FumoFumo-006",
      "description": "Alice Margatroid",
      "quantity": 5,
      "uom": "each",
      "allocatedQuantity": 0,
      "pickedQuantity": 0,
      "deliveredQuantity": 0
    },
    {
      "id": 97,
      "itemId": 2306,
      "sku": "FumoFumo-002",
      "description": "Marisa Kirisame",
      "quantity": 5,
      "uom": "each",
      "allocatedQuantity": 0,
      "pickedQuantity": 0,
      "deliveredQuantity": 0
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.