POST | /api/purchaseorders | Create a new PurchaseOrder |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UserId | body | string | No | |
UserEmail | body | string | No | |
CreatedDate | body | DateTime | No | |
Void | body | bool | No | |
CouponCode | body | string | No | |
OrderItems | body | List<PurchaseOrderItemDto> | No | |
PaymentType | body | string | No | |
BillingInformationDto | body | BillingInformationDto | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
PurchaseOrderId | form | int | No | |
ProductId | form | string | No | |
ProductName | form | string | No | |
Quantity | form | int | No | |
Price | form | decimal | No | |
DiscountDescription | form | string | No | |
DiscountSource | form | string | No | |
Discount | form | decimal | No | |
CreatedDate | form | DateTime | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CardNumber | form | string | No | |
CardType | form | string | No | |
ExpireMonth | form | int | No | |
ExpireYear | form | int | No | |
Cvv2 | form | string | No | |
FirstName | form | string | No | |
LastName | form | string | No | |
City | form | string | No | |
CountryCode | form | string | No | |
Line1 | form | string | No | |
PostalCode | form | string | No | |
State | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Message | form | string | No | |
Status | form | HttpStatusCode | No | |
PurchaseOrder | form | PurchaseOrderDto | No | |
Details | form | List<Details> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
UserId | form | string | No | |
CreatedDate | form | DateTime | No | |
PaymentType | form | string | No | |
Void | form | bool | No | |
Paid | form | bool | No | |
TransactionIdentifier | form | string | No | |
CouponCode | form | string | No | |
OrderItems | form | List<PurchaseOrderItem> | No | |
Payer | form | string | No | |
BillingAddressLine1 | form | string | No | |
BillingAddressCity | form | string | No | |
BillingAddressState | form | string | No | |
BillingAddressPostalCode | form | string | No | |
BillingAddressCountryCode | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
PurchaseOrderId | form | int | No | |
ProductId | form | string | No | |
ProductName | form | string | No | |
Quantity | form | int | No | |
Price | form | decimal | No | |
DiscountDescription | form | string | No | |
DiscountSource | form | string | No | |
Discount | form | decimal | No | |
CreatedDate | form | DateTime | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Code | form | string | No | |
Field | form | string | No | |
Issue | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/purchaseorders HTTP/1.1
Host: accounts.dev.healthmonix.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
userId: String,
userEmail: String,
createdDate: 0001-01-01,
void: False,
couponCode: String,
orderItems:
[
{
id: 0,
purchaseOrderId: 0,
productId: String,
productName: String,
quantity: 0,
price: 0,
discountDescription: String,
discountSource: String,
discount: 0,
createdDate: 0001-01-01
}
],
paymentType: String,
billingInformationDto:
{
cardNumber: String,
cardType: String,
expireMonth: 0,
expireYear: 0,
cvv2: String,
firstName: String,
lastName: String,
city: String,
countryCode: String,
line1: String,
postalCode: String,
state: String
}
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { message: String, status: Continue, purchaseOrder: { id: 0, userId: String, createdDate: 0001-01-01, paymentType: String, void: False, paid: False, transactionIdentifier: String, couponCode: String, orderItems: [ { id: 0, purchaseOrderId: 0, productId: String, productName: String, quantity: 0, price: 0, discountDescription: String, discountSource: String, discount: 0, createdDate: 0001-01-01 } ], payer: String, billingAddressLine1: String, billingAddressCity: String, billingAddressState: String, billingAddressPostalCode: String, billingAddressCountryCode: String }, details: [ { code: String, field: String, issue: String } ] }