v1

latestOpenAPI 3.1.02026-07-2413054.9 KB

Edit Takeout Order

put/pickup-orders/{orderId}

orderIdstring required

Unique identifier of the pickup order

Authorizationstring

Replace the BgxsDwd00n.LNNn90QydrjgZ1K9dS13 part with your own API_KEY from Shipday for authentication.

Content-Typestring

orderNumberstring required

Alphanumeric identifier for the order object

additionalIdstring

Additional ID for the order

tipsnumber double

Tips amount for the order

taxnumber double

Tax amount for the order

discountAmountnumber double

Discount amount for the order

totalOrderCostnumber double

Total cost for the particular order

paymentMethod'CARD' | 'CASH' | 'ONLINE'

Selected payment method for the order

pickupInstructionstring

Pickup related instructions for the order

expectedPickupDatestring date

Expected pickup date in UTC for the particular order (yyyy-mm-dd format)

expectedPickupTimestring time

Expected pickup time in UTC for the particular order (format hh:mm:ss)

orderSourcestring

Source of the order

companyIdinteger

Company identifier associated with the order

status'IN_PROGRESS' | 'READY' | 'DONE' | 'CANCEL'

Current status of the order

200

successboolean

orderIdinteger

messagestring

{
  "success": true,
  "orderId": 643528,
  "message": "Pickup Order updated successfully."
}