API Documentation

Retrieve a list of pick tickets

OData

P4W utilizes OData when querying database through API calls. Following example retrieves first 20 pick tickets (including corresponding warehouse and assigned clients if applicable) sorted by creation date.

GET https://{tenant_name}p4warehouse.com/odata/PickTicket

Query Parameters

NameTypeDescription

$expand

String

A list of collections or data entities to be included in the response

$orderby

String

Date created

$top

Double

Number of picktickets to retrieve

$count

Boolean

Whether to displays total number of picktickets available

Headers

NameTypeDescription

ApiKey*

String

System API key

{
    "@odata.context": "https://doc1.p4warehouse.com/odata/$metadata#PickTicket(Warehouse(Id,WarehouseCode),FirstPickBin(Id,BinCode),Customer(Id,CustomerCode,CompanyName),Client(Id,Name),AssignedUser(Id,Username))",
    "@odata.count": 87,
    "value": [
        {
            "PickTicketNumber": "PCK-0000143",
            "WarehouseId": "1ab1f713-a451-4019-9e3c-25624374508c",
            "FreightType": "SmallParcel",
            "DockDoorId": null,
            "PickTicketState": "ReadyToPick",
            "CustomerId": "4cc9ebc2-4e8a-49a8-8f84-c9b191a01e97",
            "PoNumber": null,
            "IsWarehouseTransfer": false,
            "ToWarehouseId": null,
            "ParentBackOrderId": null,
            "CountOnShip": false,
            "SignOnShip": false,
            "DriverId": null,
            "VehicleId": null,
            "SealNumber": null,
            "ShipConfirmSignature": null,
            "CountOnDelivery": false,
            "SignOnDelivery": false,
            "DeliveryConfirmSignature": null,
            "PercentageAllocated": 1.0000,
            "PercentagePicked": 0.0000,
            "TotalLines": 1,
            "TotalQuantity": 1.00,
            "QuotedTruckLoadShippingCost": null,
            "ActualTruckLoadShippingCost": null,
            "Carrier": "UPS"

Use OData syntax to personalize queries through API calls.

Example of OData query

https://{tenant_name}.p4warehouse.com/odata/PickTicket
?$expand=Warehouse($select=Id,WarehouseCode),FirstPickBin($select=Id,BinCode),Customer($select=Id,CustomerCode,CompanyName),Client($select=Id,Name),AssignedUser($select=Id,Username)&$orderby=DateCreated
desc
&$top=20
&$filter=PickTicketState ne 'Closed'
&$count=true