POST BrokerHub/Purchases/Search Try Now

Search Broker Hub Purchase

Request Information

URI Parameters

NameDescriptionTypeAdditional information

Body Parameters

NameDescriptionTypeAdditional information
OrderNumber
integer
None.
Customer
string
None.
ClientCompany
string
None.
ClientPhone
string
None.
ClientEmail
string
None.
ShippingCarrier
the shipping carrier.
Collection of ShippingCarrier
None.
ShippingTrackingNumber
the shipping tracking number.
string
None.
ShippingStatus
the shipping status.
Collection of ShippingStatus
None.
ShippingType
the type of the shipping.
Collection of ShippingType
None.
PaymentStatus
the payment status.
Collection of PaymentStatus
None.
OrderStatus
the order status.
Collection of PurchaseStatus
None.
HoldingSubscriberId
string
None.
HoldingOrderId
string
None.
HoldingExternalOrderNumber
string
None.
DateAdded
Date Added
DateValue
None.
DateExpected
Date Expected
DateValue
None.
DateShipped
Date Expected
DateValue
None.
Page
integer
None.
ItemsPerPage
integer
None.
OrderBy
string
None.
SortOrder
string
None.
DateUpdated
date
None.
UpdatedSince
DateValue
None.

Request Formats

application/json, text/json

Sample:
{
  "OrderNumber": 1,
  "Customer": "",
  "ClientCompany": "",
  "ClientPhone": "",
  "ClientEmail": "",
  "ShippingCarrier": [
    "None"
  ],
  "ShippingTrackingNumber": "",
  "ShippingStatus": [
    "Any"
  ],
  "ShippingType": [
    "None"
  ],
  "PaymentStatus": [
    "Any"
  ],
  "OrderStatus": [
    "Open"
  ],
  "HoldingSubscriberId": "",
  "HoldingOrderId": "",
  "HoldingExternalOrderNumber": "",
  "DateAdded": {
    "FromDate": "2019-01-16T11:59",
    "ToDate": "2019-01-16T12:00",
    "FilterByTime": true
  },
  "DateExpected": {
    "FromDate": "2019-01-16T11:59",
    "ToDate": "2019-01-16T12:00",
    "FilterByTime": true
  },
  "DateShipped": {
    "FromDate": "2019-01-16T11:59",
    "ToDate": "2019-01-16T12:00",
    "FilterByTime": true
  },
  "Page": 10,
  "ItemsPerPage": 11,
  "OrderBy": "",
  "SortOrder": null,
  "DateUpdated": "2019-01-16T11:59",
  "UpdatedSince": {
    "FromDate": "2019-01-16T11:59",
    "ToDate": "2019-01-16T12:00",
    "FilterByTime": true
  }
}

Response Information

Resource Description

NameDescriptionTypeAdditional information
PurchaseId
the purchase identifier.
string
None.
OrderNumber
the order number.
integer
None.
ClientCompany
the customer company.
string
None.
ClientPhone
the customer phone.
string
None.
ClientEmail
the customer email.
string
None.
ClientCSR
the customer CSR.
string
None.
Currency
the currency.
string
None.
SubTotal
Gets the sub total.
Money
None.
Tax
the tax.
Money
None.
Total
Gets the grand total.
Money
None.
ExtraCost
the extra cost.
Money
None.
ShippingCost
the shipping cost.
Money
None.
Commission
Money
None.
Discount
the discount.
Money
None.
DateExpected
the date expected.
date
None.
DateShipped
the date shipped.
date
None.
ShippingCarrier
the shipping carrier.
ShippingCarrier
None.
ShippingService
the shipping service.
string
None.
ShippingTrackingNumber
the shipping tracking number.
string
None.
ShippingStatus
the shipping status.
ShippingStatus
None.
ShippingType
the type of the shipping.
ShippingType
None.
PaymentStatus
the payment status.
PaymentStatus
None.
HoldingSubscriberId
the holding subscriber identifier.
string
None.
HoldingInvoiceId
the holding invoice identifier.
string
None.
CreditCardId
the credit card identifier.
string
None.
CreatedBy
the created by.
string
None.
PODate
the date added.
date
None.
HoldingExternalOrderNumber
the items.
string
None.
Item
PurchaseItem
None.

Response Formats

application/json, text/json

Sample:
{
  "PurchaseId": "",
  "OrderNumber": 2,
  "ClientCompany": "",
  "ClientPhone": "",
  "ClientEmail": "",
  "ClientCSR": "",
  "Currency": "",
  "SubTotal": {
    "Currency": "",
    "Amount": 1.0
  },
  "Tax": {
    "Currency": "",
    "Amount": 1.0
  },
  "Total": {
    "Currency": "",
    "Amount": 1.0
  },
  "ExtraCost": {
    "Currency": "",
    "Amount": 1.0
  },
  "ShippingCost": {
    "Currency": "",
    "Amount": 1.0
  },
  "Commission": {
    "Currency": "",
    "Amount": 1.0
  },
  "Discount": {
    "Currency": "",
    "Amount": 1.0
  },
  "DateExpected": "2019-01-16T11:59",
  "DateShipped": "2019-01-16T11:59",
  "ShippingCarrier": "None",
  "ShippingService": "",
  "ShippingTrackingNumber": "",
  "ShippingStatus": "Any",
  "ShippingType": "None",
  "PaymentStatus": "Any",
  "HoldingSubscriberId": "",
  "HoldingInvoiceId": "",
  "CreditCardId": "",
  "CreatedBy": "",
  "PODate": "2019-01-16T11:59",
  "HoldingExternalOrderNumber": "",
  "Item": {
    "Id": "",
    "Event": "",
    "Venue": "",
    "EventDate": "2019-01-16T11:59",
    "Section": "",
    "Row": "",
    "Low": 7,
    "High": 8,
    "Seats": "",
    "Quantity": 10,
    "UnitPrice": 11.0,
    "UnitPriceCurrency": "",
    "Commission": {
      "Currency": "",
      "Amount": 1.0
    },
    "SubTotal": {
      "Currency": "",
      "Amount": 1.0
    },
    "Total": {
      "Currency": "",
      "Amount": 1.0
    },
    "Discount": {
      "Currency": "",
      "Amount": 1.0
    },
    "Overs": {
      "Currency": "",
      "Amount": 1.0
    },
    "TaxAmount": {
      "Currency": "",
      "Amount": 1.0
    },
    "TaxName": "",
    "AdditionalTaxName": "",
    "AdditionalTax": 15.0
  }
}