Create new pick ticket

transactional can take both, say it here, interchangeble

End Point

'CreateOrUpdate' API end point is used to create new pick tickets.

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

Headers

Request Body

{
    "$id": "1",
    "PickTicketNumber": "PCK-0000148",
    "FreightTypeEnum": 1,
    "FreightType": "SmallParcel",
    "DockDoorId": null,
    "DockDoor": null,
    "PickTicketStateEnum": 0,
    "PickTicketState": "Draft",
    "CustomerId": "4cc9ebc2-4e8a-49a8-8f84-c9b191a01e97",
    "Customer": {
        "$id": "2",
        "CustomerCode": "ECOM",
        "ClientId": "91c64445-04d0-41da-a9ce-f05c0db7d4d4",
        "Client": {
            "$id": "3",
            "Name": "02",
            "CompanyName": null,
            "Description": "DemoClient02",
            "TaxId": null,
            "Logo": null,
            "PackslipDisclaimer": null,
            "ProformaInvoiceDisclaimer": null,
            "ReturnsDisclaimer": null,
            "ReceivingSlipDisclaimer": null,
            "Email": null,
            "Phone": null,
            "ContactPerson": null,
            "BolHazmatMessage": null,
            "ThreePLBillingEnabled": false,
            "IsPrintPackslipOnShip": null,
            "IsPrintTruckLoadOnSign": null,
            "IsGeneratePickTicketBackOrder": null,
            "IsGeneratePoBackOrder": null,
            "IsEmailPackslips": null,
            "PackslipToEmails": null,
            "PackslipCcEmails": null,
            "PackslipBccEmails": null,
            "PackslipEmailSubject": null,
            "PackslipEmailBody": null,
            "IsEmailReceivingSlips": null,
            "ReceivingSlipToEmails": null,
            "ReceivingSlipCcEmails": null,
            "ReceivingSlipBccEmails": null,
            "ReceivingSlipEmailSubject": null,
            "ReceivingSlipEmailBody": null,
            "IsEmailCustomerReturnSlips": null,
            "CustomerReturnToEmails": null,
            "CustomerReturnCcEmails": null,
            "CustomerReturnBccEmails": null,
            "CustomerReturnEmailSubject": null,
            "CustomerReturnEmailBody": null,
            "IsEmailBols": null,
            "BolToEmails": null,
            "BolCcEmails": null,
            "BolBccEmails": null,
            "BolEmailSubject": null,
            "BolEmailBody": null,
            "SmallParcelBrokerEnum": 1,
            "SmallParcelBroker": "EasyPost",
            "SmallParcelBrokerUrl": null,
            "SmallParcelBrokerApiKey": null,
            "SmallParcelCarrierServices": null,
            "SmallParcelCarrierAccounts": null,
            "SsccCompanyId": "0123457",
            "NextSsccNumber": 76,
            "BolPrefix": null,
            "Products": [],
            "ProductBundles": [],
            "PurchaseOrders": [],
            "Vendors": [],
            "Users": [],
            "Invoices": [],
            "BillingProfiles": [],
            "Zones": [],
            "Bins": [],
            "Info1": null,
            "Info2": null,
            "Info3": null,
            "Info4": null,
            "Info5": null,
            "Info6": null,
            "Info7": null,
            "Info8": null,
            "Info9": null,
            "Info10": null,
            "Address1": null,
            "Address2": null,
            "City": null,
            "StateProvince": null,
            "ZipPostalCode": null,
            "Country": null,
            "AddressHash": "",
            "Id": "91c64445-04d0-41da-a9ce-f05c0db7d4d4",
            "DateCreated": "2022-04-28T16:11:16.8693864+00:00",
            "TypeName": "Pro4Soft.TenantData.Entities.Business.Client3PL.Client",
            "TypeNameShort": "Client"
        },
        "CompanyName": "e-comm",
        "ContactPerson": null,
        "Email": null,
        "Phone": null,
        "TaxId": null,
        "BillToName": null,
        "BillToPhone": null,
        "BillToAddress1": null,
        "BillToAddress2": null,
        "BillToCity": null,
        "BillToStateProvince": null,
        "BillToZipPostal": null,
        "BillToCountry": null,
        "DefaultCountOnShip": null,
        "DefaultSignOnShip": null,
        "DefaultCountOnDelivery": null,
        "DefaultSignOnDelivery": null,
        "TruckLoadConsolidationGroup": null,
        "Description": "DemoCustomer02",
        "Logo": null,
        "PackslipDisclaimer": null,
        "ProformaInvoiceDisclaimer": null,
        "ReturnsDisclaimer": null,
        "IsGeneratePickTicketBackOrder": null,
        "IsPrintPackslipOnShip": null,
        "IsPrintTruckLoadOnSign": null,
        "OutboundProductExpiryAllowance": null,
        "InboundProductExpiryAllowance": null,
        "Addresses": [],
        "PickTickets": [
            {
                "$ref": "1"
            }
        ],
        "CustomerReturns": [],
        "CartonizationProfileId": null,
        "CartonizationProfile": null,
        "Info1": null,
        "Info2": null,
        "Info3": null,
        "Info4": null,
        "Info5": null,
        "Info6": null,
        "Info7": null,
        "Info8": null,
        "Info9": null,
        "Info10": null,
        "Id": "4cc9ebc2-4e8a-49a8-8f84-c9b191a01e97",
        "DateCreated": "2022-06-10T15:39:00.5352572+00:00",
        "TypeName": "Pro4Soft.TenantData.Entities.Business.Fulfillment.Customer",
        "TypeNameShort": "Customer"
    },
    "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": "4",
        "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": null,
    "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": null,
    "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": {
        "$id": "5",
        "WarehouseCode": "01",
        "IsDiscontinued": false,
        "Name": "Warehouse1",
        "Description": "Demo_Warehouse_1",
        "Phone": "708-519-0932",
        "ReferenceNumber": null,
        "Reference1": null,
        "Reference2": null,
        "Reference3": null,
        "Zones": [],
        "DefaultUsers": [],
        "DockDoors": [],
        "MinMax": [],
        "PurchaseOrders": [],
        "ProductionOrders": [],
        "CustomerReturns": [],
        "TruckLoads": [],
        "Address1": "3607 Hog Camp Road",
        "Address2": "2",
        "City": "Burr Ridge",
        "StateProvince": "IL",
        "ZipPostalCode": "61257",
        "Country": "US",
        "AddressHash": "3607 Hog Camp Road2Burr RidgeIL61257US",
        "Id": "1ab1f713-a451-4019-9e3c-25624374508c",
        "DateCreated": "2022-05-04T17:22:29.5472225+00:00",
        "TypeName": "Pro4Soft.TenantData.Entities.Business.Warehousing.Warehouse",
        "TypeNameShort": "Warehouse"
    },
    "ClientId": "91c64445-04d0-41da-a9ce-f05c0db7d4d4",
    "Client": {
        "$ref": "3"
    },
    "Lines": [],
    "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"
}

JSON Example

Here is an example of a JSON payload to create new pick ticket with pick ticket number, picking instructions, ship to address, reference number, and item lines.

{
    "WarehouseId":"1ab1f713-a451-4019-9e3c-25611374508c",
    "CustomerId":"4cc9ebc2-4e8a-49a8-8f84-c9b163a01e97"
    "PickTicketNumber":"PCK001",
    "PickingInstructions":"Demo instructions",
    "ReferenceNumber":"RF0120230824",
    "ShipToEmail": "demo@email.com",
    "ShipToAttnTo": "Roger Nadal",
    "ShipToName": "R. Nadal",
    "ShipToPhone": "123456789",
    "ShipToAddress1": "3189 Park Drive Road",
    "ShipToAddress2": "34",
    "ShipToCity": "Aurora",
    "ShipToStateProvince": "CO",
    "ShipToZipPostal": "20134",
    "ShipToCountry": "US",
    "Lines": [
        {
            "Sku":"PRODUCT002",
            "OrderedQuantity":2
        },
        {
            "Sku":"PRODUCT008",
            "OrderedQuantity":10
        }
        ]
}

Notice: API calls regarding pick ticket operations can utilize user assigned number and codes (i.e. 'WarehouseNumber', 'PickTicketNumber', 'CustomerCode') instead of system generated Ids.

Using system generated Id is a robust approach and is preferable when dealing with mutliclient setup.