GET BrokerHub/Orders/{orderId} Try Now

Get Broker Hub Order

Request Information

URI Parameters

NameDescriptionTypeAdditional information
orderId
The purchase order id
string
Required

Body Parameters

None.

Response Information

Resource Description

NameDescriptionTypeAdditional information
SubscriberId
string
None.
InvoiceId
string
None.
InvoiceNumber
integer
None.
InvoiceStatus
InvoiceStatus
None.
ShippingStatus
ShippingStatus
None.
PaymentStatus
PaymentStatus
None.
CustomerId
string
None.
ShipFromAddressId
string
None.
ShipToContactId
string
None.
BillToContactId
string
None.
ShipTo
Contact
None.
BillTo
Contact
None.
ShipFromAddress
SubscriberAddress
None.
ExternalOrderNumber
string
None.
Currency
string
None.
InvoiceType
InvoiceType
None.
Tax
Money
None.
AdditionalTax
Money
None.
ServiceFee
Money
None.
Discount
Money
None.
Commission
Money
None.
Items
Collection of InvoiceItem
None.
SubTotal
Money
None.
GrandTotal
Money
None.
BalanceAmount
decimal number
None.
ShippingType
ShippingType
None.
ShippingCarrier
ShippingCarrier
None.
ShippingService
string
None.
ShippingCost
decimal number
None.
ShippingTrackingNumber
string
None.
AirbillPath
string
None.
DeliverySource
ProcessedAt
None.
DeliveryResult
TUDeliveryResult
None.
AutoConfirm
boolean
None.
ConfirmationSource
ProcessedAt
None.
ClientCSRId
string
None.
SubscriberCSRId
string
None.
Notes
string
None.
Version
integer
None.
VoidReason
string
None.
ReferralName
string
None.
ReferralTypeId
string
None.
HasTags
boolean
None.
ZoneCode
Zone
None.
ProcessedAt
ProcessedAt
None.
DateRaised
date
None.
DateExpected
date
None.
DateShipped
date
None.
DateReceived
date
None.
DateAdded
date
None.
DateUpdated
date
None.
DateVoided
date
None.
DateReleased
date
None.
CreatedBy
string
None.
UpdatedBy
string
None.
Payments
Collection of InvoicePayment
None.
CustomItems
Collection of InvoiceCustomItem
None.
IsMigrated
boolean
None.
IsModified
boolean
None.
Paid
Money
None.
Tags
Collection of string
None.
ExternalConfirmationInfo
string
None.
CurrentUTCDate
date
None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.