All Collections
Developer API
Inventory API: Pick Tickets
Inventory API: Pick Tickets

Retrieve and update pick tickets for your third-party warehouse

Mike Maloney avatar
Written by Mike Maloney
Updated over a week ago

Pick Tickets

Pick tickets can only be created in Uphance but third-party applications can retrieve pick tickets and can update pick tickets to mark them shipped or to add tracking information. See Webhooks to learn about getting notified when a pick ticket is created or deleted in Uphance.

Get all pick tickets

Retrieve details for all pick tickets, optionally filtered in some way. This endpoint will return 100 pick tickets at most (see the Pagination section to learn how to access all pages).

$ curl https://api.uphance.com/pick_tickets \
    -H "Authorization: ACCESS_TOKEN"

Get pick tickets with filters

You can pass one or more filter parameters to scope the pick tickets returned. For example, you can request for Pick Tickets with pick ticket ID greater than the last pick ticket ID retrieved in the previous call.

$ curl https://api.uphance.com/pick_tickets?since_id=PICK_TICKET_ID \
    -H "Authorization: ACCESS_TOKEN"

Similarly, you can request for Pick Tickets with creation date time greater than that of the last pick ticket ID retrieved in the previous call.

$ curl https://api.uphance.com/pick_tickets?since_created_at= PICK_TICKET_DATE_TIME \
    -H "Authorization: ACCESS_TOKEN"

Or, request Pick Tickets for a specific warehouse.

$ curl https://api.uphance.com/pick_tickets?filter[warehouse_name]= WAREHOUSE_NAME \ 
     -H "Authorization: ACCESS_TOKEN"

Or, request Pick Tickets for a specific order by passing in either order number or order ID.

$ curl https://api.uphance.com/pick_tickets?by_order_number=ORDER_NUMBER
     -H "Authorization: ACCESS_TOKEN"
$ curl https://api.uphance.com/pick_tickets?by_order_id=ORDER_ID
     -H "Authorization: ACCESS_TOKEN"

Or, request Pick Tickets for a specific shipment number. Shipment number is normally the same as pick ticket number and will return only one pick ticket, except when you use enhanced shipping.

$ curl https://api.uphance.com/pick_tickets?by_shipment_number= SHIPMENT_NUMBER
     -H "Authorization: ACCESS_TOKEN"

Get a single pick ticket

Retrieve details of an existing pick ticket.

$ curl https://api.uphance.com/pick_tickets/PICK_TICKET_ID \
    -H "Authorization: ACCESS_TOKEN"

Example response:

{
    "pick_ticket": {
        "id": 102312,
        "created_at": "2018-11-13T16:43:10.000+00:00",
        "updated_at": "2018-11-13T16:43:10.000+00:00",
        "stock_adjusted_at": null,
        "tracking_number": null,
        "items_total": "1455.0",
        "items_tax": "0.0",
        "subtotal": "1455.0",
        "total_tax": "0.0",
        "grand_total": "1455.0",
        "total_quantity": 50,
        "currency": "USD",
        "order_number": 142,
        "order_id": 106497,
        "order_source": "wholesale",
        "shipment_number": 166,
        "commercial_invoice_number": 166,
        "organisation_id": 9579,
        "date": "2018-11-13",
        "shipping_cost": "0.0",
        "shipping_tax": "0.0",
        "address": "999 STITCH AVENUE, Los Angeles, CA 90210, UNITED STATES",
        "line_items": [
            {
                "id": 752606,
                "product_id": 86847,
                "product_name": "Uphance Handbag",
                "variation_id": 176269,
                "color": "Black",
                "unit_tax": "0.0",
                "tax_level": "0.0",
                "unit_price": "29.1",
                "original_price": "30.0",
                "percentage_discount": "3.0",
                "line_quantities": [
                    {
                        "id": 3853555,
                        "size": "One",
                        "quantity": 50,
                        "sku_id": 952242
                    }
                ]
            },
            {
                "id": 752607,
                "product_id": 86847,
                "product_name": "Uphance Handbag",
                "variation_id": 176270,
                "color": "Blue",
                "unit_tax": "0.0",
                "tax_level": "0.0",
                "unit_price": "29.1",
                "original_price": "30.0",
                "percentage_discount": "3.0",
                "line_quantities": [
                    {
                        "id": 3853556,
                        "size": "One",
                        "quantity": 0,
                        "sku_id": 952243
                    }
                ]
            },
            {
                "id": 752608,
                "product_id": 77633,
                "product_name": "Nice Dress",
                "variation_id": 163786,
                "color": "Blue",
                "unit_tax": "0.0",
                "tax_level": "0.0",
                "unit_price": "48.5",
                "original_price": "50.0",
                "percentage_discount": "3.0",
                "line_quantities": [
                    {
                        "id": 3853557,
                        "size": "XS",
                        "quantity": 0,
                        "sku_id": 1127538
                    },
                    {
                        "id": 3853558,
                        "size": "S",
                        "quantity": 0,
                        "sku_id": 867869
                    },
                    {
                        "id": 3853559,
                        "size": "M",
                        "quantity": 0,
                        "sku_id": 867870
                    },
                    {
                        "id": 3853560,
                        "size": "L",
                        "quantity": 0,
                        "sku_id": 867871
                    },
                    {
                        "id": 3853561,
                        "size": "XL",
                        "quantity": 0,
                        "sku_id": 1127542
                    },
                    {
                        "id": 3853562,
                        "size": "XXL",
                        "quantity": 0,
                        "sku_id": 1130587
                    },
                    {
                        "id": 3853563,
                        "size": "XXXL",
                        "quantity": 0,
                        "sku_id": 1130591
                    }
                ]
            },
            {
                "id": 752609,
                "product_id": 77633,
                "product_name": "Nice Dress",
                "variation_id": 163789,
                "color": "Yellow",
                "unit_tax": "0.0",
                "tax_level": "0.0",
                "unit_price": "14.55",
                "original_price": "15.0",
                "percentage_discount": "3.0",
                "line_quantities": [
                    {
                        "id": 3853564,
                        "size": "XS",
                        "quantity": 0,
                        "sku_id": 1127541
                    },
                    {
                        "id": 3853565,
                        "size": "S",
                        "quantity": 0,
                        "sku_id": 867878
                    },
                    {
                        "id": 3853566,
                        "size": "M",
                        "quantity": 0,
                        "sku_id": 867879
                    },
                    {
                        "id": 3853567,
                        "size": "L",
                        "quantity": 0,
                        "sku_id": 867880
                    },
                    {
                        "id": 3853568,
                        "size": "XL",
                        "quantity": 0,
                        "sku_id": 1127545
                    },
                    {
                        "id": 3853569,
                        "size": "XXL",
                        "quantity": 0,
                        "sku_id": 1130590
                    },
                    {
                        "id": 3853570,
                        "size": "XXXL",
                        "quantity": 0,
                        "sku_id": 1130594
                    }
                ]
            }
        ],
        "dimensions": null,
        "gross_weight": null,
        "net_weight": null
    }
}

Update Pick Ticket Status

Mark a pick ticket shipped as well add tracking information

PUT https://api.uphance.com/pick_tickets/PICK_TICKET_ID/ship

Mark a pick ticket unshipped

PUT https://api.uphance.com/pick_tickets/PICK_TICKET_ID/unship

Update tracking information on a shipped Pick Ticket

PUT https://api.uphance.com/pick_tickets/PICK_TICKET_ID?date=SHIP_DATE&tracking_number=TRACKING_NUMBER&carrier=CARRIER

Next steps

Did this answer your question?