GET BrokerHub/Purchases/{PurchaseId} Try Now

Get Broker Hub Purchase

Request Information

URI Parameters

NameDescriptionTypeAdditional information
PurchaseId
The purchase order id
string
Required

Body Parameters

None.

Response Information

Resource Description

NameDescriptionTypeAdditional information
PurchaseId
string
None.
SubscriberId
string
None.
OrderNumber
integer
None.
CustomerId
string
None.
ClientCompany
string
None.
ClientPhone
string
None.
ClientEmail
string
None.
ClientCSR
string
None.
ClientCSRId
string
None.
Currency
string
None.
SubTotal
Money
None.
Tax
Money
None.
GrandTotal
Money
None.
Overs
Money
None.
ShippingCost
Money
None.
Commission
Money
None.
Discount
Money
None.
BalanceAmount
Money
None.
DateExpected
date
None.
DateShipped
date
None.
ShippingCarrier
ShippingCarrier
None.
ShippingService
string
None.
ShippingTrackingNumber
string
None.
ShippingStatus
ShippingStatus
None.
ShippingTypeId
string
None.
ShippingType
ShippingType
None.
PaymentStatus
PaymentStatus
None.
OrderStatus
PurchaseStatus
None.
InvoiceId
string
None.
POId
string
None.
OrderId
string
None.
HoldingSubscriberId
string
None.
HoldingInvoiceId
string
None.
HoldingOrderId
string
None.
CreditCardId
string
None.
SubscriberCSRId
string
None.
SubscriberCSR
string
None.
Note
string
None.
Version
integer
None.
Comment
string
None.
CreatedBy
string
None.
DateAdded
date
None.
HoldingExternalOrderNumber
string
None.
Items
Collection of PurchaseItem
None.
BillTo
PurchaseAddress
None.
ShipTo
PurchaseAddress
None.
ShipFrom
PurchaseAddress
None.

Response Formats

application/json, text/json

Sample:
{
  "PurchaseId": "",
  "SubscriberId": "",
  "OrderNumber": 3,
  "CustomerId": "",
  "ClientCompany": "",
  "ClientPhone": "",
  "ClientEmail": "",
  "ClientCSR": "",
  "ClientCSRId": "",
  "Currency": "",
  "SubTotal": {
    "Currency": "",
    "Amount": 1.0
  },
  "Tax": {
    "Currency": "",
    "Amount": 1.0
  },
  "GrandTotal": {
    "Currency": "",
    "Amount": 1.0
  },
  "Overs": {
    "Currency": "",
    "Amount": 1.0
  },
  "ShippingCost": {
    "Currency": "",
    "Amount": 1.0
  },
  "Commission": {
    "Currency": "",
    "Amount": 1.0
  },
  "Discount": {
    "Currency": "",
    "Amount": 1.0
  },
  "BalanceAmount": {
    "Currency": "",
    "Amount": 1.0
  },
  "DateExpected": "2019-08-21T22:26",
  "DateShipped": "2019-08-21T22:26",
  "ShippingCarrier": "None",
  "ShippingService": "",
  "ShippingTrackingNumber": "",
  "ShippingStatus": "Any",
  "ShippingTypeId": "",
  "ShippingType": "None",
  "PaymentStatus": "Any",
  "OrderStatus": "Open",
  "InvoiceId": "",
  "POId": "",
  "OrderId": "",
  "HoldingSubscriberId": "",
  "HoldingInvoiceId": "",
  "HoldingOrderId": "",
  "CreditCardId": "",
  "SubscriberCSRId": "",
  "SubscriberCSR": "",
  "Note": "",
  "Version": 26,
  "Comment": "",
  "CreatedBy": "",
  "DateAdded": "2019-08-21T22:26",
  "HoldingExternalOrderNumber": "",
  "Items": [
    {
      "PurchaseItemId": "",
      "PurchaseId": "",
      "Event": "",
      "Venue": "",
      "EventDate": "2019-08-21T22:26",
      "EventId": "",
      "VenueId": "",
      "Section": "",
      "Row": "",
      "LowSeat": 10,
      "HighSeat": 11,
      "Seats": "",
      "Seating": "Any",
      "Quantity": 13,
      "Unit": "",
      "UnitPrice": 15.0,
      "UnitPriceCurrency": "",
      "Commission": 17.0,
      "SubTotal": 195.0,
      "Total": 275.0,
      "Discount": 18.0,
      "Overs": 19.0,
      "TaxAmount": 20.0,
      "TaxName": "",
      "AdditionalTaxName": "",
      "AdditionalTax": 23.0,
      "DateAdded": "2019-08-21T22:26",
      "DateUpdated": "2019-08-21T22:26",
      "UpdatedBy": ""
    }
  ],
  "BillTo": {
    "PurchaseAddressId": "",
    "PurchaseId": "",
    "ContactId": "",
    "JobTitle": "",
    "State": "",
    "AddressId": "",
    "FirstName": "",
    "LastName": "",
    "Company": "",
    "Address1": "",
    "Address2": "",
    "City": "",
    "StateId": "",
    "StateOther": "",
    "StateISO": "",
    "CountryId": "",
    "Zip": "",
    "Email": "",
    "SubscriberId": "",
    "Phone": "",
    "Cell": "",
    "Fax": "",
    "AddressType": "Billing",
    "ReferenceId": "",
    "CountryCode": "",
    "Country": ""
  },
  "ShipTo": {
    "PurchaseAddressId": "",
    "PurchaseId": "",
    "ContactId": "",
    "JobTitle": "",
    "State": "",
    "AddressId": "",
    "FirstName": "",
    "LastName": "",
    "Company": "",
    "Address1": "",
    "Address2": "",
    "City": "",
    "StateId": "",
    "StateOther": "",
    "StateISO": "",
    "CountryId": "",
    "Zip": "",
    "Email": "",
    "SubscriberId": "",
    "Phone": "",
    "Cell": "",
    "Fax": "",
    "AddressType": "Billing",
    "ReferenceId": "",
    "CountryCode": "",
    "Country": ""
  },
  "ShipFrom": {
    "PurchaseAddressId": "",
    "PurchaseId": "",
    "ContactId": "",
    "JobTitle": "",
    "State": "",
    "AddressId": "",
    "FirstName": "",
    "LastName": "",
    "Company": "",
    "Address1": "",
    "Address2": "",
    "City": "",
    "StateId": "",
    "StateOther": "",
    "StateISO": "",
    "CountryId": "",
    "Zip": "",
    "Email": "",
    "SubscriberId": "",
    "Phone": "",
    "Cell": "",
    "Fax": "",
    "AddressType": "Billing",
    "ReferenceId": "",
    "CountryCode": "",
    "Country": ""
  }
}