Retrieve Bulk Orders

Use this end point to display bulk order details

SecurityBearer

Request

path Parameters

version

required

string

query Parameters

limit	integer <int32>
start_index	integer <int32>
order_guid	string <uuid> order guid
package_guid	string <uuid> package guid
person_guid	string <uuid>
company_guid	string <uuid>
start_search_date	string <date-time> start search date
end_search_date	string <date-time> end search date
bulk_order_status	string bulk order status- PENDING,CREATED,CANCELLED,SHIPPED

Responses

200

Returns the bulk order details

400

Bad request

401

Unauthorized

404

Order not found

500

Server Error

get/api/{version}/bulkorders

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"count": 0,
"start_index": 0,
"end_index": 0,
"has_more": true,
"data": [{"order_guid": "dd878538-67b6-4e7d-8e8a-ddc3e971d02f",
"program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
"package_guid": "bbcfa7f4-7eee-4d1b-9f7d-736ad8949479",
"order_type": "string",
"shipping_method": "string",
"tracking_number": "string",
"order_count": 0,
"bulk_order_status": "string",
"order_date": "2019-08-24T14:15:22Z",
"package_name": "string",
"order_error_message": "string",
"carrier": "string",
"person": {"person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"mailing_city": "string",
"mailing_country": "str",
"mailing_address_line1": "string",
"address_line2": "string",
"postal_code": "string",
"state": "string",
"location_name": "string",
"email_address": "string",
"mobile_number": "string",
"office_number": "string"
}
}
],
"check_statuses": ["string"
]
}