Contributors:
CRM Orders API
Retrieve and Update Order Items via the public API endpoint using "where" filtering.
GET CRM Orders List
Retrieves a list of Orders as a JSON response based on your provided query parameters.
/api/v2/admin/orders
Data / Response:
{
"Where" : {},
"Order_By" : "Id",
"Offset" : 0,
"Limit" : 100,
}
{
"Items": [
{
"Id": 0,
"AWBNumber": "string",
"CurrencyCountry": "string",
"Currency": "string",
"Country": "string",
"InvoiceDate": "2024-05-17T18:47:05.068Z",
"InvoiceNumber": 0,
"IsDeleted": true,
"IsRecurring": true,
"MainOrderId": 0,
"MemberId": 0,
"OrderName": "string",
"PaymentState": "None",
"StatusId": 0,
"TotalCost": 0,
"CreatedDateTime": "2024-05-17T18:47:05.068Z",
"HasSubscriptions": true,
"HasPaidSubscription": true,
"TrackingURL": "string",
"TransactionId": "string",
"AmountPaid": 0,
"AmountPending": 0,
"OrderCaseType": "FormCase",
"StatusShort": {
"Id": 0,
"Name": "string"
},
"Discount": {
"Code": "string",
"Cost": 0
},
"GiftVoucher": {
"Name": "string",
"Cost": 0
},
"Tax": {
"Code": "string",
"Rate": 0
},
"ShippingInfo": {
"Name": "string",
"Cost": 0,
"Address": "string",
"City": "string",
"State": "string",
"Zipcode": "string",
"Country": "string"
},
"Member": {
"Id": 0,
"Email": "string",
"FirstName": "string",
"LastName": "string"
},
"OrderLines": [
{
"Id": 0,
"EntityType": "Form",
"ProductId": 0,
"ModuleId": 0,
"ProductName": "string",
"Quantity": 0,
"TaxRate": 0,
"UnitPrice": 0,
"TotalPrice": 0,
"FileName": "string",
"IsDownload": true,
"Attributes": [
{
"AttributeId": 0,
"OptionsIds": [
"string"
]
}
]
}
],
"Payments": [
{
"Id": 0,
"Amount": 0,
"AmountCaptured": 0,
"GatewayReason": "string",
"TransactionId": "string",
"Status": "string",
"PaymentType": "CreditCard",
"PaymentGatewayType": "stripe",
"Notes": "string",
"CreatedDateTime": "2024-05-17T18:47:05.068Z"
}
],
"CustomCrmGroups": {
"<GroupAlias1>": {
"<FieldAlias1>": "<value>",
"<FieldAlias2>": false,
"<FieldAlias3>": 0
}
}
}
],
"TotalItemsCount": 0
}
POST CRM Order Create
Creates a new Order based on the provided data.
/api/v2/admin/orders
Data / Response:
{
"AWBNumber": "string",
"InvoiceDate": "2024-05-17T18:47:19.760Z",
"InvoiceNumber": 0,
"MainOrderId": 0,
"MemberId": 0,
"OrderName": "string",
"PaymentState": "None",
"StatusId": "string",
"TrackingURL": "string",
"ShippingZipCode": "string",
"ShippingState": "string",
"ShippingAddress": "string",
"ShippingCity": "string",
"ShippingCountry": "string"
}
{
"Id": 0,
"AWBNumber": "string",
"CurrencyCountry": "string",
"Currency": "string",
"Country": "string",
"InvoiceDate": "2024-05-17T18:47:19.762Z",
"InvoiceNumber": 0,
"IsDeleted": true,
"IsRecurring": true,
"MainOrderId": 0,
"MemberId": 0,
"OrderName": "string",
"PaymentState": "None",
"StatusId": 0,
"TotalCost": 0,
"CreatedDateTime": "2024-05-17T18:47:19.762Z",
"HasSubscriptions": true,
"HasPaidSubscription": true,
"TrackingURL": "string",
"TransactionId": "string",
"AmountPaid": 0,
"AmountPending": 0,
"OrderCaseType": "FormCase",
"StatusShort": {
"Id": 0,
"Name": "string"
},
"Discount": {
"Code": "string",
"Cost": 0
},
"GiftVoucher": {
"Name": "string",
"Cost": 0
},
"Tax": {
"Code": "string",
"Rate": 0
},
"ShippingInfo": {
"Name": "string",
"Cost": 0,
"Address": "string",
"City": "string",
"State": "string",
"Zipcode": "string",
"Country": "string"
},
"Member": {
"Id": 0,
"Email": "string",
"FirstName": "string",
"LastName": "string"
},
"OrderLines": [
{
"Id": 0,
"EntityType": "Form",
"ProductId": 0,
"ModuleId": 0,
"ProductName": "string",
"Quantity": 0,
"TaxRate": 0,
"UnitPrice": 0,
"TotalPrice": 0,
"FileName": "string",
"IsDownload": true,
"Attributes": [
{
"AttributeId": 0,
"OptionsIds": [
"string"
]
}
]
}
],
"Payments": [
{
"Id": 0,
"Amount": 0,
"AmountCaptured": 0,
"GatewayReason": "string",
"TransactionId": "string",
"Status": "string",
"PaymentType": "CreditCard",
"PaymentGatewayType": "stripe",
"Notes": "string",
"CreatedDateTime": "2024-05-17T18:47:19.762Z"
}
],
"CustomCrmGroups": {
"<GroupAlias1>": {
"<FieldAlias1>": "<value>",
"<FieldAlias2>": false,
"<FieldAlias3>": 0
}
}
}
GET CRM Order Item
Retrieves a single Order based on the ID passed in the endpoint URL.
/api/v2/admin/orders/{id}
Data / Response:
N/A
{
"Id": 0,
"AWBNumber": "string",
"CurrencyCountry": "string",
"Currency": "string",
"Country": "string",
"InvoiceDate": "2024-05-17T18:47:19.762Z",
"InvoiceNumber": 0,
"IsDeleted": true,
"IsRecurring": true,
"MainOrderId": 0,
"MemberId": 0,
"OrderName": "string",
"PaymentState": "None",
"StatusId": 0,
"TotalCost": 0,
"CreatedDateTime": "2024-05-17T18:47:19.762Z",
"HasSubscriptions": true,
"HasPaidSubscription": true,
"TrackingURL": "string",
"TransactionId": "string",
"AmountPaid": 0,
"AmountPending": 0,
"OrderCaseType": "FormCase",
"StatusShort": {
"Id": 0,
"Name": "string"
},
"Discount": {
"Code": "string",
"Cost": 0
},
"GiftVoucher": {
"Name": "string",
"Cost": 0
},
"Tax": {
"Code": "string",
"Rate": 0
},
"ShippingInfo": {
"Name": "string",
"Cost": 0,
"Address": "string",
"City": "string",
"State": "string",
"Zipcode": "string",
"Country": "string"
},
"Member": {
"Id": 0,
"Email": "string",
"FirstName": "string",
"LastName": "string"
},
"OrderLines": [
{
"Id": 0,
"EntityType": "Form",
"ProductId": 0,
"ModuleId": 0,
"ProductName": "string",
"Quantity": 0,
"TaxRate": 0,
"UnitPrice": 0,
"TotalPrice": 0,
"FileName": "string",
"IsDownload": true,
"Attributes": [
{
"AttributeId": 0,
"OptionsIds": [
"string"
]
}
]
}
],
"Payments": [
{
"Id": 0,
"Amount": 0,
"AmountCaptured": 0,
"GatewayReason": "string",
"TransactionId": "string",
"Status": "string",
"PaymentType": "CreditCard",
"PaymentGatewayType": "stripe",
"Notes": "string",
"CreatedDateTime": "2024-05-17T18:47:19.762Z"
}
],
"CustomCrmGroups": {
"<GroupAlias1>": {
"<FieldAlias1>": "<value>",
"<FieldAlias2>": false,
"<FieldAlias3>": 0
}
}
}
PUT CRM Order Update
Updates a single Order based on the ID passed in the endpoint URL and data provided.
/api/v2/admin/orders/{id}
Data / Response:
{
"Id": 0,
"AWBNumber": "string",
"Currency": "string",
"Country": "string",
"InvoiceDate": "2024-05-17T18:46:42.469Z",
"InvoiceNumber": 0,
"MainOrderId": 0,
"MemberId": 0,
"OrderName": "string",
"PaymentState": "None",
"StatusId": "string",
"TrackingURL": "string",
"ShippingZipCode": "string",
"ShippingState": "string",
"ShippingAddress": "string",
"ShippingCity": "string",
"ShippingCountry": "string"
}
{
"Id": 0,
"AWBNumber": "string",
"CurrencyCountry": "string",
"Currency": "string",
"Country": "string",
"InvoiceDate": "2024-05-17T18:47:19.762Z",
"InvoiceNumber": 0,
"IsDeleted": true,
"IsRecurring": true,
"MainOrderId": 0,
"MemberId": 0,
"OrderName": "string",
"PaymentState": "None",
"StatusId": 0,
"TotalCost": 0,
"CreatedDateTime": "2024-05-17T18:47:19.762Z",
"HasSubscriptions": true,
"HasPaidSubscription": true,
"TrackingURL": "string",
"TransactionId": "string",
"AmountPaid": 0,
"AmountPending": 0,
"OrderCaseType": "FormCase",
"StatusShort": {
"Id": 0,
"Name": "string"
},
"Discount": {
"Code": "string",
"Cost": 0
},
"GiftVoucher": {
"Name": "string",
"Cost": 0
},
"Tax": {
"Code": "string",
"Rate": 0
},
"ShippingInfo": {
"Name": "string",
"Cost": 0,
"Address": "string",
"City": "string",
"State": "string",
"Zipcode": "string",
"Country": "string"
},
"Member": {
"Id": 0,
"Email": "string",
"FirstName": "string",
"LastName": "string"
},
"OrderLines": [
{
"Id": 0,
"EntityType": "Form",
"ProductId": 0,
"ModuleId": 0,
"ProductName": "string",
"Quantity": 0,
"TaxRate": 0,
"UnitPrice": 0,
"TotalPrice": 0,
"FileName": "string",
"IsDownload": true,
"Attributes": [
{
"AttributeId": 0,
"OptionsIds": [
"string"
]
}
]
}
],
"Payments": [
{
"Id": 0,
"Amount": 0,
"AmountCaptured": 0,
"GatewayReason": "string",
"TransactionId": "string",
"Status": "string",
"PaymentType": "CreditCard",
"PaymentGatewayType": "stripe",
"Notes": "string",
"CreatedDateTime": "2024-05-17T18:47:19.762Z"
}
],
"CustomCrmGroups": {
"<GroupAlias1>": {
"<FieldAlias1>": "<value>",
"<FieldAlias2>": false,
"<FieldAlias3>": 0
}
}
}
DELETE CRM Order Delete
Deletes a single Order based on the ID passed in the endpoint URL.
/api/v2/admin/orders/{id}
Data / Response:
N/A
Status 204
PUT CRM Order Custom CRM Group Data Update
Updates a single Order's Custom CRM Groups based on the form data provided.
/api/v2/admin/orders/{id}/custom-crm-groups
Data / Response:
FormSubmissionData
Status 204
API v1 (Legacy WebinOne v6)
GET Orders List
Returns order items as a JSON response based on your provided query parameters.
/api/v1/orders
Data / Response:
{
"fields" : "Status,Member,Discount,GiftVoucher,Tax,ShippingInfo,OrderLines,Payments,CustomCrmGroups",
"where" : {},
"order_by" : "Id",
"offset" : 0,
"limit" : 100,
}
{
"Items": [
{
"Id": 28057,
"AWBNumber": null,
"AmountPaid": 10.00,
"AmountPending": 0.00,
"CreatedDateTime": "2022-01-14T09:47:37",
"CurrencyCountry": "USD/US",
"Currency": "USD",
"Country": "US",
"HasPaidSubscription": false,
"HasSubscriptions": false,
"InvoiceDate": "2022-01-14T09:47:37",
"InvoiceNumber": 65,
"IsRecurring": false,
"MainOrderId": null,
"MemberId": 28049,
"OrderCaseType": "FormCase",
"OrderName": "General Payment",
"PaymentState": "Succeeded",
"StatusId": 13176,
"TotalCost": 10.00,
"TrackingUrl": null,
"TransactionId": "4X232065C5059574H",
"Status" :
{
"Id": 13176,
"Name": "Paid",
},
"Member":
{
"Id": 28049,
"Email": "test@test.com",
"FirstName": null,
"LastName": null
},
"Discount" :
{
"Code": null,
"Cost": 0.00,
},
"GiftVoucher" :
{
"Name": null,
"Cost": 0.00,
},
"Tax" :
{
"Code": null,
"Rate": 0.00,
},
"ShippingInfo":
{
"Name": null,
"Cost": 0.00,
"Address": null,
"City": null,
"State": null,
"Zipcode": null,
"Country": "US"
},
"OrderLines":
[
{
"Id": 28058,
"EntityType": null,
"ProductId": null,
"ModuleId": null,
"ProductName": "General Payment",
"Quantity": 1,
"TaxRate": 0,
"UnitPrice": 10.00,
"TotalPrice": 10.00,
"FileName": null,
"IsDownload": false,
"Attributes": []
}
],
"Payments":
[
{
"Id": 28060,
"CreatedDateTime": "2022-01-14T11:47:00",
"Amount": 2.00,
"AmountCaptured": 2.00,
"GatewayReason": null,
"TransactionId": null,
"Status": "Succeeded",
"PaymentType": "Cash",
"PaymentGatewayType": 0,
"Notes": null
}
],
"CustomCrmGroups":
{
"<GroupAlias1>":
{
"<FieldAlias1>": "<value>",
"<FieldAlias2>": false,
"<FieldAlias3>": 0
}
}
}
],
"TotalItemsCount": 100
}
GET Order Item
Returns a single order item as a JSON response based on your provided ID.
/api/v1/orders/:id
Data / Response:
"N/A"
{
"Id": 28057,
"AWBNumber": null,
"AmountPaid": 10.00,
"AmountPending": 0.00,
"CreatedDateTime": "2022-01-14T09:47:37",
"CurrencyCountry": "USD/US",
"Currency": "USD",
"Country": "US",
"HasPaidSubscription": false,
"HasSubscriptions": false,
"InvoiceDate": "2022-01-14T09:47:37",
"InvoiceNumber": 65,
"IsRecurring": false,
"MainOrderId": null,
"MemberId": 28049,
"OrderCaseType": "FormCase",
"OrderName": "General Payment",
"PaymentState": "Succeeded",
"StatusId": 13176,
"TotalCost": 10.00,
"TrackingUrl": null,
"TransactionId": "4X232065C5059574H",
"Status" :
{
"Id": 13176,
"Name": "Paid",
},
"Member":
{
"Id": "28049",
"Email": "test@test.com",
"FirstName": null,
"LastName": null
},
"Discount" :
{
"Code": null,
"Cost": 0.00,
},
"GiftVoucher" :
{
"Name": null,
"Cost": 0.00,
},
"Tax" :
{
"Code": null,
"Rate": 0.00,
},
"ShippingInfo":
{
"Name": null,
"Cost": 0.00,
"Address": null,
"City": null,
"State": null,
"Zipcode": null,
"Country": "US"
},
"OrderLines":
[
{
"Id": 28058,
"EntityType": null,
"ProductId": null,
"ModuleId": null,
"ProductName": "General Payment",
"Quantity": 1,
"TaxRate": 0,
"UnitPrice": 10.00,
"TotalPrice": 10.00,
"FileName": null,
"IsDownload": false,
"Attributes": []
}
],
"Payments":
[
{
"Id": 28060,
"CreatedDateTime": "2022-01-14T11:47:00",
"Amount": 2.00,
"AmountCaptured": 2.00,
"GatewayReason": null,
"TransactionId": null,
"Status": "Succeeded",
"PaymentType": "Cash",
"PaymentGatewayType": 0,
"Notes": null
}
],
"CustomCrmGroups":
{
"<GroupAlias1>":
{
"<FieldAlias1>": "<value>",
"<FieldAlias2>": false,
"<FieldAlias3>": 0
}
}
}
PUT Order Update
Updates and returns a single order item as a JSON response based on your provided data.
/api/v1/orders/:id
Data / Response:
{
"Id": 28057,
"AWBNumber": null,
"CreatedDateTime": "2022-01-14T09:47:37",
"Currency": "USD",
"Country": "US",
"InvoiceDate": "2022-01-14T09:47:37",
"InvoiceNumber": 65,
"MainOrderId": null,
"MemberId": 28049,
"OrderName": "General Payment",
"PaymentState": "Succeeded",
"StatusId": 13176,
"TrackingUrl": null
}
{
"Id": 28057,
"AWBNumber": null,
"AmountPaid": 10.00,
"AmountPending": 0.00,
"CreatedDateTime": "2022-01-14T09:47:37",
"CurrencyCountry": "USD/US",
"Currency": "USD",
"Country": "US",
"HasPaidSubscription": false,
"HasSubscriptions": false,
"InvoiceDate": "2022-01-14T09:47:37",
"InvoiceNumber": 65,
"IsRecurring": false,
"MainOrderId": null,
"MemberId": 28049,
"OrderCaseType": "FormCase",
"OrderName": "General Payment",
"PaymentState": "Succeeded",
"StatusId": 13176,
"TotalCost": 10.00,
"TrackingUrl": null,
"TransactionId": "4X232065C5059574H",
"Status" :
{
"Id": 13176,
"Name": "Paid",
},
"Member":
{
"Id": "28049",
"Email": "test@test.com",
"FirstName": null,
"LastName": null
},
"Discount" :
{
"Code": null,
"Cost": 0.00,
},
"GiftVoucher" :
{
"Name": null,
"Cost": 0.00,
},
"Tax" :
{
"Code": null,
"Rate": 0.00,
},
"ShippingInfo":
{
"Name": null,
"Cost": 0.00,
"Address": null,
"City": null,
"State": null,
"Zipcode": null,
"Country": "US"
},
"OrderLines":
[
{
"Id": 28058,
"EntityType": null,
"ProductId": null,
"ModuleId": null,
"ProductName": "General Payment",
"Quantity": 1,
"TaxRate": 0,
"UnitPrice": 10.00,
"TotalPrice": 10.00,
"FileName": null,
"IsDownload": false,
"Attributes": []
}
],
"Payments":
[
{
"Id": 28060,
"CreatedDateTime": "2022-01-14T11:47:00",
"Amount": 2.00,
"AmountCaptured": 2.00,
"GatewayReason": null,
"TransactionId": null,
"Status": "Succeeded",
"PaymentType": "Cash",
"PaymentGatewayType": 0,
"Notes": null
}
],
"CustomCrmGroups":
{
"<GroupAlias1>":
{
"<FieldAlias1>": "<value>",
"<FieldAlias2>": false,
"<FieldAlias3>": 0
}
}
}