# Transfer Orders

A Transfer Order is an inventory transaction that is initiated by the branch requesting inventory items from the warehouse.

# The Transfer Order Object

# Sample

{
  "items": [
    {
      "pivot": {
        "quantity": 20
      },
      "id": "8f7b966d"
    }
  ],
  "branch": {
    "id": "8f7ab00a"
  },
  "warehouse": {
    "id": "8f7ab00a"
  },
  "creator": {
    "id": "8f7aafee"
  },
  "poster": {
    "id": "8f7aafee"
  },
  "id": "8f89829b",
  "business_date": "2020-01-05",
  "reference": "TO-000001",
  "poster_id": "8f7aafee",
  "status": 3,
  "notes": "Restock Needed",
  "created_at": "2020-01-05 07:00:45",
  "updated_at": "2020-01-05 07:03:56"
}

# Attributes

Field	Type	Rule	Description
`id`	`string`		Unique identifier for the transfer order.
`business_date`	`string`	`nullable` `updatable`	Business date of the transfer order.
`reference`	`string`	`nullable` `updatable`	Reference of the transfer order.
`notes`	`string`	`nullable` `updatable`	Notes of the transfer order.
`status*`	`integer`	`updatable`	The Transfer Order Status.
`items*`	`array`	`updatable` `includable`	List of Inventory Items attached to the transfer order
`branch*`	`object`	`updatable` `includable`	The Branch involved in the transfer order
`warehouse*`	`object`	`updatable` `includable`	TheWarehouse involved in the transfer order
`creator*`	`object`	`updatable` `includable`	The User who created the transfer order
`poster*`	`object`	`includable`	The User who posted the transfer order
`created_at`	`string`	`sortable`	Time `YYYY-MM-DD HH-MM-SS` in UTC at which the object was created.
`updated_at`	`string`	`sortable`	Time `YYYY-MM-DD HH-MM-SS` in UTC at which the object was updated.

# Transfer Order Statuses

Type	Description
`1`	Draft.
`2`	Opened.
`3`	Closed.
`4`	Accepted.
`5`	Declined.

# List Transfer Orders

GET /transfer_orders

# Scope

inventory.transactions.read

# Filters

id
business_date
reference
status
branch_id
warehouse_id
creator_id
poster_id
business_date_after
business_date_before
updated_after
for_branch_id
created_on
updated_on

# Response

{
  "data": [
    {
      "items": [
        {
          "pivot": {
            "quantity": 20
          },
          "id": "8f7b966d"
        }
      ],
      "branch": {
        "id": "8f7ab00a"
      },
      "warehouse": {
        "id": "8f7ab00a"
      },
      "creator": {
        "id": "8f7aafee"
      },
      "poster": {
        "id": "8f7aafee"
      },
      "id": "8f89829b",
      "business_date": "2020-01-05",
      "reference": "TO-000001",
      "poster_id": "8f7aafee",
      "status": 3,
      "notes": "Restock Needed",
      "created_at": "2020-01-05 07:00:45",
      "updated_at": "2020-01-05 07:03:56"
    }
  ]
}

# Get Transfer Order

GET /transfer_orders/{transferOrderId}

# Scope

inventory.transactions.read

# Response

{
  "data": {
    "items": [
      {
        "pivot": {
          "quantity": 20
        },
        "id": "8f7b966d"
      }
    ],
    "branch": {
      "id": "8f7ab00a"
    },
    "warehouse": {
      "id": "8f7ab00a"
    },
    "creator": {
      "id": "8f7aafee"
    },
    "poster": {
      "id": "8f7aafee"
    },
    "id": "8f89829b",
    "business_date": "2020-01-05",
    "reference": "TO-000001",
    "poster_id": "8f7aafee",
    "status": 3,
    "notes": "Restock Needed",
    "created_at": "2020-01-05 07:00:45",
    "updated_at": "2020-01-05 07:03:56"
  }
}

# Create Transfer order

Transfer Orders can be created in all available statuses.

POST /transfer_orders

# Scope

inventory.transactions.write

# Request

{
    "business_date": "2019-05-25",
    "reference": "TO0001",
    "status": 1,
    "notes": "",
    "branch_id": "8d207fc3",
    "warehouse_id": "8d207fc3",
    "creator_id": "8d207fc3",
    "poster_id": "8d207fc3",
    "items": [
        {
            "id": "8d207fc3",
            "quantity": 200
        }
    ]
}

# Response

{
  "data": {
    "items": [
      {
        "pivot": {
          "quantity": 20
        },
        "id": "8f7b966d"
      }
    ],
    "branch": {
      "id": "8f7ab00a"
    },
    "warehouse": {
      "id": "8f7ab00a"
    },
    "creator": {
      "id": "8f7aafee"
    },
    "poster": {
      "id": "8f7aafee"
    },
    "id": "8f89829b",
    "business_date": "2020-01-05",
    "reference": "TO-000001",
    "poster_id": "8f7aafee",
    "status": 3,
    "notes": "Restock Needed",
    "created_at": "2020-01-05 07:00:45",
    "updated_at": "2020-01-05 07:03:56"
  }
}

# Update Transfer Order

PUT /transfer_orders/{transferOrderId}

# Scope

inventory.transactions.write

# Request

{
    "business_date": "2019-05-25",
    "reference": "TO0001",
    "status": 1,
    "notes": "",
    "branch_id": "8d207fc3",
    "warehouse_id": "8d207fc3",
    "creator_id": "8d207fc3",
    "poster_id": "8d207fc3",
    "items": [
        {
            "id": "8d207fc3",
            "quantity": 200
        }
    ]
}

# Response

{
  "data": {
    "items": [
      {
        "pivot": {
          "quantity": 20
        },
        "id": "8f7b966d"
      }
    ],
    "branch": {
      "id": "8f7ab00a"
    },
    "warehouse": {
      "id": "8f7ab00a"
    },
    "creator": {
      "id": "8f7aafee"
    },
    "poster": {
      "id": "8f7aafee"
    },
    "id": "8f89829b",
    "business_date": "2020-01-05",
    "reference": "TO-000001",
    "poster_id": "8f7aafee",
    "status": 3,
    "notes": "Restock Needed",
    "created_at": "2020-01-05 07:00:45",
    "updated_at": "2020-01-05 07:03:56"
  }
}

# Delete Transfer Order

The API will respond with 200 indicating that the transfer order has been deleted.

DELETE /transfer_orders/{transferOrderId}

← Suppliers Warehouses →