API Documentation

Add pickticket line

End Point

'CreateOrUpdate' API end point is used to add products to the pickticket lines.

POST https://{tenant_name}.p4warehouse.com/api/PickTicketLineApi/CreateOrUpdate

Headers

Request Body

{
    "$id": "1",
    "LineNumber": 1,
    "PickTicketId": "3f0c5448-9648-4483-8b89-42ea5a77a04d",
    "PickTicket": {
        "$id": "2",
        "PickTicketNumber": "PCK-0000148",
        "FreightTypeEnum": 1,
        "FreightType": "SmallParcel",
        "DockDoorId": null,
        "DockDoor": null,
        "PickTicketStateEnum": 0,
        "PickTicketState": "Draft",
        "CustomerId": "4cc9ebc2-4e8a-49a8-8f84-c9b191a01e97",
        "Customer": null,
        "PoNumber": null,
        "IsWarehouseTransfer": false,
        "ToWarehouseId": null,
        "ToWarehouse": null,
        "WarehouseTransferPurchaseOrders": null,
        "ParentBackOrderId": null,
        "ParentBackOrder": null,
        "BackOrders": null,
        "CountOnShip": false,
        "SignOnShip": false,
        "DriverId": null,
        "VehicleId": null,
        "SealNumber": null,
        "ShipConfirmSignature": null,
        "CountOnDelivery": false,
        "SignOnDelivery": false,
        "DeliveryConfirmSignature": null,
        "QuotedTruckLoadShippingCost": null,
        "ActualTruckLoadShippingCost": null,
        "Carrier": "UPS",
        "ShippingService": "GND",
        "SmallParcelOptionsObject": {
            "$id": "3",
            "IsCountOnShip": false,
            "IsSignOnShip": false,
            "IsCountOnDelivery": false,
            "IsSignOnDelivery": false,
            "Carrier": null,
            "Service": null,
            "CarrierScac": null,
            "FreightChargeTerms": 0,
            "PaymentType": 0,
            "CarrierAccountNumber": "",
            "InternationTaxId": null,
            "IsResidential": false,
            "COD": false,
            "SaturdayPickup": false,
            "SaturdayDelivery": false,
            "SignatureRequired": false,
            "PrintReturnLabel": false,
            "BillToName": null,
            "BillToPhone": null,
            "BillToAddress1": null,
            "BillToAddress2": null,
            "BillToCity": null,
            "BillToStateProvince": null,
            "BillToZipPostalCode": null,
            "BillToCountry": null
        },
        "SmallParcelOptions": "{\"IsCountOnShip\":false,\"IsSignOnShip\":false,\"IsCountOnDelivery\":false,\"IsSignOnDelivery\":false,\"Carrier\":null,\"Service\":null,\"CarrierScac\":null,\"FreightChargeTerms\":\"Empty\",\"PaymentType\":\"Prepay\",\"CarrierAccountNumber\":\"\",\"InternationTaxId\":null,\"IsResidential\":false,\"COD\":false,\"SaturdayPickup\":false,\"SaturdayDelivery\":false,\"SignatureRequired\":false,\"PrintReturnLabel\":false,\"BillToName\":null,\"BillToPhone\":null,\"BillToAddress1\":null,\"BillToAddress2\":null,\"BillToCity\":null,\"BillToStateProvince\":null,\"BillToZipPostalCode\":null,\"BillToCountry\":null}",
        "ReferenceNumber": "1234567890",
        "Reference1": null,
        "Reference2": null,
        "Reference3": null,
        "ShippingRuleCode": "RL-00004",
        "ShipVia": null,
        "AllocationSettings": null,
        "GeoTimeStamp": null,
        "CurrentLongitude": null,
        "CurrentLatitude": null,
        "ShipToGeoCodedAddress": null,
        "ShipToLatitude": null,
        "ShipToLongitude": null,
        "ShipToEmail": null,
        "ShipToAttnTo": null,
        "ShipToName": "A.Smith",
        "ShipToPhone": null,
        "ShipToAddress1": null,
        "ShipToAddress2": null,
        "ShipToCity": null,
        "ShipToStateProvince": null,
        "ShipToZipPostal": null,
        "ShipToCountry": null,
        "ShipToHash": "",
        "BillToName": null,
        "BillToPhone": null,
        "BillToAddress1": null,
        "BillToAddress2": null,
        "BillToCity": null,
        "BillToStateProvince": null,
        "BillToZipPostal": null,
        "BillToCountry": null,
        "ShipFromGeoCodedAddress": null,
        "ShipFromLatitude": null,
        "ShipFromLongitude": null,
        "AppointmentNumber": null,
        "AppointmentDate": null,
        "RouteNumber": null,
        "Container": null,
        "ShipFromName": "Demo P4B",
        "ShipFromPhone": "708-519-0932",
        "ShipFromAddress1": "3607 Hog Camp Road",
        "ShipFromAddress2": "2",
        "ShipFromCity": "Burr Ridge",
        "ShipFromStateProvince": "IL",
        "ShipFromZipPostal": "61257",
        "ShipFromCountry": "US",
        "WaveNumber": null,
        "Comments": null,
        "PickingInstructions": null,
        "SystemMessage": null,
        "IsHeldShort": null,
        "IsPendingLetdown": null,
        "IsPendingProduction": null,
        "IsPendingPacksizeBreakdown": null,
        "FirstPickBinId": null,
        "FirstPickBin": null,
        "CancelDate": null,
        "RequiredDate": null,
        "MustArriveDate": null,
        "ReleasedToFloorDate": null,
        "AllocatedDate": null,
        "CartonizeDate": null,
        "WavedDate": null,
        "PickingStartedDate": null,
        "PickingCompletedDate": null,
        "ShipConfirmDate": null,
        "ShippedDate": null,
        "DeliveryConfirmDate": null,
        "CloseDate": null,
        "SuspendedDate": null,
        "UploadDate": null,
        "UploadedSuceeded": null,
        "UploadMessage": null,
        "WarehouseId": "1ab1f713-a451-4019-9e3c-25624374508c",
        "Warehouse": null,
        "ClientId": "91c64445-04d0-41da-a9ce-f05c0db7d4d4",
        "Client": null,
        "Lines": [
            {
                "$ref": "1"
            }
        ],
        "Totes": [],
        "CartonizationDetails": [],
        "AssignedUserId": null,
        "AssignedUser": null,
        "Tag1": null,
        "Tag2": null,
        "Tag3": null,
        "Tag4": null,
        "Tag5": null,
        "Info1": null,
        "Info2": null,
        "Info3": null,
        "Info4": null,
        "Info5": null,
        "Info6": null,
        "Info7": null,
        "Info8": null,
        "Info9": null,
        "Info10": null,
        "Id": "3f0c5448-9648-4483-8b89-42ea5a77a04d",
        "DateCreated": "2023-08-17T16:10:05.6846024+00:00",
        "TypeName": "Pro4Soft.TenantData.Entities.Business.Fulfillment.PickTicket",
        "TypeNameShort": "PickTicket"
    },
    "ProductId": "9c1e8c1c-24e3-46da-921f-899124d60ba7",
    "Product": null,
    "ProductBundleId": null,
    "ProductBundle": null,
    "Packsize": null,
    "NumberOfPacks": null,
    "LotNumber": null,
    "Instructions": null,
    "ReferenceNumber": null,
    "Reference1": null,
    "Reference2": null,
    "Reference3": null,
    "OrderedQuantity": 1.0,
    "AllocatedQuantity": null,
    "PendingProduction": null,
    "PickedQuantity": null,
    "ShippedQuantity": null,
    "DeliveredQuantity": null,
    "SalesPrice": null,
    "ToteLines": [],
    "InventoryReservations": [],
    "InventoryPickShorts": [],
    "ProductionOrders": [],
    "Info1": null,
    "Info2": null,
    "Info3": null,
    "Info4": null,
    "Info5": null,
    "Info6": null,
    "Info7": null,
    "Info8": null,
    "Info9": null,
    "Info10": null,
    "Id": "bc793fe6-c1d6-45ca-bde9-62c41b8b57ab",
    "DateCreated": "2023-08-17T18:09:47.7710393+00:00",
    "TypeName": "Pro4Soft.TenantData.Entities.Business.Fulfillment.PickTicketLine",
    "TypeNameShort": "PickTicketLine"
}

Newly created lines are assigned with 'Id' number. Use this number to edit lines using API calls.

Notice: Product ID and 'SKU' are interchangable when dealing with pick ticket lines.

JSON Example

Here is an example of a JSON payload to add a pick ticket line with a product and ordered quantity. 

{
    "Id": "c98cf9ee-114e-4667-aead-ad943cfe4360",
    "ProductId": "f8ee74b8-6868-40f0-b8fb-ecd2ee2d6940",
    "OrderedQuantity": 2
}