{id} Try Now

Get Purchase Order.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The Purchase Order Id.	string	Required

Body Parameters

None.

Response Information

Resource Description

Returns Purchase Order

GetPurchaseOrderResponse

Name	Description	Type	Additional information
PurchaseOrderId	The purchase order identifier.	string	None.
PONumber	The purchase order number.	long	None.
ExternalOrderNumber	The external order number.	string	None.
POType	The type of the purchase order.	POType	None.
POStatus	The purchase order status.	PurchaseOrderStatus	None.
PaymentStatus	The payment status.	PaymentStatus	None.
ShippingStatus	The shipping status.	ShippingStatus	None.
ShippingCost	The shipping cost.	Money	None.
GrandTotal	The total.	Money	None.
ShippingType	The type of the shipping.	ShippingType	None.
ShippingTrackingNumber	The shipping tracking number.	string	None.
ShippingTypeId	The shipping type identifier.	string	None.
ShippingCarrier	The shipping carrier.	ShippingCarrier	None.
ShippingService	The shipping service.	string	None.
SubscriberCSRId	The subscriber CSR identifier.	string	None.
Notes	The notes.	string	None.
ConsignCommission	The consign commission.	decimal number	None.
ConsignmentOperation	The consign operation.	ConsignOperation	None.
VoidReason	The void reason.	string	None.
ProcessedAt	The processed at.	ProcessedAt	None.
DateRaised	The date raised.	date	None.
DateVoided	The date voided.	date	None.
DateReceived	The date received.	date	None.
Items	The purchase order items.	Collection of PurchaseOrderItem	None.
CustomItems	The purchase order custom items.	Collection of PurchaseOrderCustomItem	None.
Payments	The purchase order payments.	Collection of PurchaseOrderPayment	None.
ShipFrom	The ship from.	Contact	None.
BillTo	The bill to.	SubscriberAddress	None.
ShipTo	The ship to.	SubscriberAddress	None.
Tags	The tags.	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "PurchaseOrderId": "",
  "PONumber": 2,
  "ExternalOrderNumber": "",
  "POType": "Any",
  "POStatus": "Any",
  "PaymentStatus": "Any",
  "ShippingStatus": "Any",
  "ShippingCost": {
    "Currency": "",
    "Amount": 1.0
  },
  "GrandTotal": {
    "Currency": "",
    "Amount": 1.0
  },
  "ShippingType": "None",
  "ShippingTrackingNumber": "",
  "ShippingTypeId": "",
  "ShippingCarrier": "None",
  "ShippingService": "",
  "SubscriberCSRId": "",
  "Notes": "",
  "ConsignCommission": 9.0,
  "ConsignmentOperation": "Any",
  "VoidReason": "",
  "ProcessedAt": "None",
  "DateRaised": "2024-11-27T18:17",
  "DateVoided": "2024-11-27T18:17",
  "DateReceived": "2024-11-27T18:17",
  "Items": [
    {
      "PurchaseOrderItemId": "",
      "Event": "",
      "Venue": "",
      "EventId": "",
      "VenueId": "",
      "EventDate": "2024-11-27T18:17",
      "Section": "",
      "Row": "",
      "Quantity": 9,
      "LowSeat": 10,
      "HighSeat": 11,
      "UnitPrice": {
        "Currency": "",
        "Amount": 1.0
      },
      "FacePrice": {
        "Currency": "",
        "Amount": 1.0
      },
      "Seating": "Any",
      "Stock": "Any",
      "Discount": {
        "Currency": "",
        "Amount": 1.0
      },
      "Tax": {
        "Currency": "",
        "Amount": 1.0
      },
      "Overs": {
        "Currency": "",
        "Amount": 1.0
      },
      "Total": {
        "Currency": "",
        "Amount": 1.0
      },
      "Currency": "",
      "Notes": ""
    }
  ],
  "CustomItems": [
    {
      "PurchaseCustomItemId": "",
      "Description": "",
      "Total": {
        "Currency": "",
        "Amount": 1.0
      }
    }
  ],
  "Payments": [
    {
      "PaymentDate": "2024-11-27T18:17",
      "PurchaseOrderPaymentId": "",
      "PaymentModeId": "",
      "PaymentMode": "Any",
      "Amount": {
        "Currency": "",
        "Amount": 1.0
      },
      "AdditionalCost": {
        "Currency": "",
        "Amount": 1.0
      },
      "ReferenceNo": "",
      "ContraEntryId": "",
      "Note": "",
      "RemainingRefundAmount": {
        "Currency": "",
        "Amount": 1.0
      },
      "PayPalFee": 7.1
    }
  ],
  "ShipFrom": {
    "AddressId": "",
    "FirstName": "",
    "LastName": "",
    "Company": "",
    "Address1": "",
    "Address2": "",
    "City": "",
    "StateId": "",
    "StateOther": "",
    "StateISO": "",
    "CountryId": "",
    "Country": "",
    "CountryCode": "",
    "TimeZoneId": "",
    "Zip": "",
    "Email": "",
    "Website": "",
    "JobTitle": "",
    "ContactId": "",
    "CustomerId": "",
    "AddressSource": "Manual",
    "ContactType": "Subscriber",
    "ContactSubType": "Contact",
    "IsPayPalVerified": true,
    "AddressNote": "",
    "ReferenceId": "",
    "State": "",
    "DateUpdated": "2024-11-27T18:17",
    "Phones": [
      {
        "PhoneId": "",
        "ContactId": "",
        "PhoneType": "Home",
        "Phone": "",
        "Extension": "",
        "IsPrimary": true,
        "IsDeleted": true
      }
    ]
  },
  "BillTo": {
    "AddressId": "",
    "FirstName": "",
    "LastName": "",
    "Company": "",
    "Address1": "",
    "Address2": "",
    "City": "",
    "StateId": "",
    "StateOther": "",
    "State": "",
    "StateISO": "",
    "CountryId": "",
    "TimeZoneId": "",
    "Zip": "",
    "Email": "",
    "Website": "",
    "JobTitle": "",
    "SubscriberId": "",
    "Phone": "",
    "Cell": "",
    "Fax": "",
    "DisplayName": "",
    "AddressType": "Billing",
    "IsResidential": true,
    "Country": "",
    "Extension": "",
    "CountryCode": "",
    "TimeZone": ""
  },
  "ShipTo": {
    "AddressId": "",
    "FirstName": "",
    "LastName": "",
    "Company": "",
    "Address1": "",
    "Address2": "",
    "City": "",
    "StateId": "",
    "StateOther": "",
    "State": "",
    "StateISO": "",
    "CountryId": "",
    "TimeZoneId": "",
    "Zip": "",
    "Email": "",
    "Website": "",
    "JobTitle": "",
    "SubscriberId": "",
    "Phone": "",
    "Cell": "",
    "Fax": "",
    "DisplayName": "",
    "AddressType": "Billing",
    "IsResidential": true,
    "Country": "",
    "Extension": "",
    "CountryCode": "",
    "TimeZone": ""
  },
  "Tags": [
    ""
  ]
}