v1

latestOpenAPI 3.1.02026-07-2438302.6 MB

Get all Transfer Orders

get/products/transfer_orders

Query parameters

filter.keywordstring

filter.from_locationstring

product location uid, multiple uid supported

filter.to_locationstring

product location uid, multiple uid supported

filter.created_at_fromstring date-time

utc format ('YYYY-MM-DDTHH:mm:ssZ', 'YYYY-MM-DD HH:mm:ss', 'YYYY-MM-DDTHH:mm:ss.SSSZ', 'YYYY-MM-DD HH:mm:ss.SSS')

filter.created_at_tostring date-time

utc format ('YYYY-MM-DDTHH:mm:ssZ', 'YYYY-MM-DD HH:mm:ss', 'YYYY-MM-DDTHH:mm:ss.SSSZ', 'YYYY-MM-DD HH:mm:ss.SSS')

filter.required_date_fromstring date

filter.required_date_tostring date

filter.sent_date_tostring date

filter.received_date_from'string date

filter.received_date_tostring date

filter.created_bystring date

user uid, multiple uids are supported

filter.transfer_order_numberstring date

filter.over_dueboolean

filter.transfer_order_status'DRAFT' | 'IN_TRANSIT' | 'COMPLETED' | 'VOIDED'

Response

200

typestring

current_pageinteger

total_pagesinteger

total_recordsinteger

Example response

{
  "type": "success",
  "current_page": 1,
  "total_pages": 2,
  "total_records": 2,
  "data": [
    {
      "prefix": "V2-004",
      "transfer_order_uid": "eb3fea4e-a78d-4c97-833f-9bf5047134b5",
      "from_location": {
        "location_uid": "1a570534-cbce-487f-9d5e-23912a1ec1c7",
        "location_name": "black team only"
      },
      "to_location": {
        "location_uid": "070df7e0-ea60-11ee-9d1c-3169492ff8f3",
        "location_name": "Aluva"
      },
      "required_by": "2024-07-25T04:44:00.000Z",
      "transfer_order_status": "DRAFT",
      "line_items_count": 1,
      "created_by": {
        "user_uid": "5c6f734f-999b-453c-89b9-c0a5c2f9b4d5",
        "first_name": "Ashin",
        "last_name": "Thankachan",
        "email": "ashin.t@zuper.co",
        "home_phone_number": "8301907278",
        "designation": "Admin",
        "emp_code": "001",
        "work_phone_number": "9600086457",
        "is_active": true,
        "created_at": "2024-01-25T05:30:47.000Z",
        "updated_at": "2024-05-03T07:47:20.000Z",
        "role": {
          "role_name": "Admin",
          "role_uid": "a355d556-6976-4e05-9842-fad5b9ebd081"
        }
      },
      "created_at": "2024-06-07T05:36:04.386Z",
      "updated_at": "2024-06-07T05:36:04.386Z",
      "transfer_order_number": 43,
      "id": "undefined"
    }
  ]
}