Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

fwdorigin
enum<string>
default:DISPATCH_API
required
Available options:
DISPATCH_API

Path Parameters

serviceOrderId
string
required

Response

200 - application/json

Order with delivery details

deliveries
object
required
payment
object | null
required
services
object[]
required
canCancel
boolean
required
isTaxable
boolean
required
totalPaid
number<float>
required
membershipBenefitsAmount
number<float>
required
promotions
string[]
required
taxAmountInCents
number<float>
required
tipOption
string | null
required
returnDeliveryTip
number<float>
required
returnDeliveryFee
number<float>
required
pickupDeliveryTip
number<float>
required
pickupDeliveryFee
number<float>
required
recurringDiscountInCents
number<float>
required
orderCodeWithPrefix
string
required
orderCode
string
required
missedPickupFee
number<float>
required
hasDryCleaning
boolean
required
returnMethod
enum<string> | null
required
Available options:
IN_STORE_PICKUP,
DELIVERY,
null
creditAmount
number<float> | null
required
tipAmount
number<float> | null
required
netOrderTotal
number<float>
required
orderTotal
number<float>
required
paymentStatus
enum<string> | null
required
Available options:
PAID,
BALANCE_DUE,
PENDING,
INVOICING,
INVOICED,
INVOICE_PAID
dueDate
required
intakeAt
required
createdAt
required
status
enum<string>
required
Available options:
READY_FOR_PROCESSING,
PROCESSING,
READY_FOR_PICKUP,
READY_FOR_DRIVER_PICKUP,
EN_ROUTE_TO_CUSTOMER,
COMPLETED,
CANCELLED,
IN_TRANSIT_TO_STORE,
SUBMITTED,
DRIVER_PICKED_UP_FROM_CUSTOMER,
DROPPED_OFF_AT_STORE,
READY_FOR_INTAKE,
IN_TRANSIT_TO_HUB,
DROPPED_OFF_AT_HUB,
DESIGNATED_FOR_PROCESSING_AT_HUB,
RECEIVED_AT_HUB_FOR_PROCESSING,
HUB_PROCESSING_COMPLETE,
HUB_PROCESSING_ORDER
balanceDue
number<float>
required
id
number<float>
required
customerNotes
object
required
orderType
enum<string>
required
Available options:
ONLINE,
RESIDENTIAL,
SERVICE
paymentTiming
enum<string>
required
Available options:
PRE-PAY,
POST-PAY
weightLogs
object[]
required
orderNotes
string | null
required

Internal note left on the order.

rack
string
required

Storage rack location, if assigned. Empty string when none.

Whether the rack location should be shown to the customer, per store settings and order state.

recurringDiscountInPercent
number<float> | null
required

Null when this order is not part of a recurring series.

convenienceFee
number<float> | null
required
convenienceFeeId
number<float> | null
required
loyaltyAmount
number<float>
required
referralAmount
number<float>
required
promotionAmount
number<float>
required
selectedCategories
object[]
required

Empty for orders placed before category selection was tracked; clients should fall back to their own derivation in that case.

invoiceCode
string