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
invoiceCode
string