Open API v2 / CRM & Orders / CRM Order Lines
CRM Order Lines
→
Every request needs a bearer token: Authorization: Bearer <token>. Base URL https://your-site.webinone.com. New to field types? See the type reference.
Creates a new order line
Parameters
idinteger · pathrequired
Resource identifier.
Body parameters
ProductIdintegerrequired
Unique system identifier of the product. Used to synchronize inventory balances.
ProductNamestring · nullable
Product name that will be displayed in the order.
Quantityintegerrequired
The number of units of a product that the customer purchases.
UnitPricenumber
Price per unit of product at the time of order placement.
Attributesarray of objects
An array of additional characteristics (variations) of the selected product.
AttributeIdinteger
Identifier of the related attribute.
OptionsIdsarray of strings
List of selected values for this attribute.
Response
Idinteger
'Member' a unique user identifier in the system. Read-only.
EntityTypeenum
Entity type. Possible values: Form, ModuleItem, SecureZoneSubscription.Possible values: FormModuleItemSecureZoneSubscription
ProductIdinteger
Unique system identifier of the product. Used to synchronize inventory balances.
ModuleIdinteger
The ID of the module or plugin responsible for this product type.
ProductNamestring · nullable
Product name that will be displayed in the order.
Quantityinteger
The number of units of a product that the customer purchases.
TaxRatenumber
The percentage tax rate that applies to this specific product.
UnitPricenumber
Price per unit of product at the time of order placement.
TotalPricenumber
Total cost of the linece per unit of product at the time of order placement.
FileNamestring · nullable
File name, if this line applies to a digital product.
IsDownloadboolean
A flag indicating whether this item is a downloadable file.
Attributesarray of objects
An array of additional characteristics (variations) of the selected product.
AttributeIdinteger
Identifier of the related attribute.
OptionsIdsarray of strings
List of selected values for this attribute.
curl -X POST "https://your-site.webinone.com/api/v2/admin/orders/1/order-lines" \ -H "Authorization: Bearer <token>" \ -H "Content-Type: application/json" \ -d '{"ProductId":1,"ProductName":"Example","Quantity":0,"UnitPrice":0,"Attributes":[{"AttributeId":1,"OptionsIds":["string"]}]}'
await fetch("https://your-site.webinone.com/api/v2/admin/orders/1/order-lines", { method: "POST", headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" }, body: JSON.stringify({ "ProductId": 1, "ProductName": "Example", "Quantity": 0, "UnitPrice": 0, "Attributes": [ { "AttributeId": 1, "OptionsIds": [ "string" ] } ] }) });
import requests requests.post( "https://your-site.webinone.com/api/v2/admin/orders/1/order-lines", headers={"Authorization": "Bearer <token>"}, json={ "ProductId": 1, "ProductName": "Example", "Quantity": 0, "UnitPrice": 0, "Attributes": [{ "AttributeId": 1, "OptionsIds": ["string"] }] } )
$client = new GuzzleHttp\Client(); $response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/orders/1/order-lines', [ 'headers' => [ 'Authorization' => 'Bearer <token>', 'Content-Type' => 'application/json' ], 'json' => [ 'ProductId' => 1, 'ProductName' => 'Example', 'Quantity' => 0, 'UnitPrice' => 0, 'Attributes' => [[ 'AttributeId' => 1, 'OptionsIds' => ['string'] ]] ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/orders/1/order-lines"); request.Headers.Add("Authorization", "Bearer <token>"); request.Content = new StringContent( "{\"ProductId\":1,\"ProductName\":\"Example\",\"Quantity\":0,\"UnitPrice\":0,\"Attributes\":[{\"AttributeId\":1,\"OptionsIds\":[\"string\"]}]}", Encoding.UTF8, "application/json"); var response = await client.SendAsync(request);
Response · 200
{
"Id": 1,
"EntityType": "Form",
"ProductId": 1,
"ModuleId": 1,
"ProductName": "Example",
"Quantity": 0,
"TaxRate": 0,
"UnitPrice": 0,
"TotalPrice": 0,
"FileName": "Example",
"IsDownload": false,
"Attributes": [
{
"AttributeId": 1,
"OptionsIds": [
"string"
]
}
]
}Retrieves a single order line
Parameters
idinteger · pathrequired
Order line id.
Response
Idinteger
'Member' a unique user identifier in the system. Read-only.
EntityTypeenum
Entity type. Possible values: Form, ModuleItem, SecureZoneSubscription.Possible values: FormModuleItemSecureZoneSubscription
ProductIdinteger
Unique system identifier of the product. Used to synchronize inventory balances.
ModuleIdinteger
The ID of the module or plugin responsible for this product type.
ProductNamestring · nullable
Product name that will be displayed in the order.
Quantityinteger
The number of units of a product that the customer purchases.
TaxRatenumber
The percentage tax rate that applies to this specific product.
UnitPricenumber
Price per unit of product at the time of order placement.
TotalPricenumber
Total cost of the linece per unit of product at the time of order placement.
FileNamestring · nullable
File name, if this line applies to a digital product.
IsDownloadboolean
A flag indicating whether this item is a downloadable file.
Attributesarray of objects
An array of additional characteristics (variations) of the selected product.
AttributeIdinteger
Identifier of the related attribute.
OptionsIdsarray of strings
List of selected values for this attribute.
curl "https://your-site.webinone.com/api/v2/admin/orders/order-lines/1" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/orders/order-lines/1", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/orders/order-lines/1", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/orders/order-lines/1', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/orders/order-lines/1"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
{
"Id": 1,
"EntityType": "Form",
"ProductId": 1,
"ModuleId": 1,
"ProductName": "Example",
"Quantity": 0,
"TaxRate": 0,
"UnitPrice": 0,
"TotalPrice": 0,
"FileName": "Example",
"IsDownload": false,
"Attributes": [
{
"AttributeId": 1,
"OptionsIds": [
"string"
]
}
]
}Updates an existing order line
Parameters
idinteger · pathrequired
Resource identifier.
Body parameters
ProductIdstringrequired
Unique system identifier of the product. Used to synchronize inventory balances.
ProductNamestring · nullable
Product name that will be displayed in the order.
Quantityinteger
The number of units of a product that the customer purchases.
UnitPricenumber
Price per unit of product at the time of order placement.
Response
Idinteger
'Member' a unique user identifier in the system. Read-only.
AWBNumberstring · nullable
Intended for the Air Waybill (or any other shipment tracking/consignment number) from your freight provider.
CurrencyCountrystring · nullable
The Currency/Country pair used for the payment processing (this field is not editable).
Currencystring · nullable
Order currency code.
Countrystring · nullable
'ShippingInfo' the contact's shipping country as entered during the checkout process.
InvoiceDatestring · date-time
Date-time - the date and time the invoice was generated.
InvoiceNumberinteger · nullable
A number assigned incrementally to each order.
VATInvoiceNumberinteger · nullable
The VAT invoice number assigned to the order for tax reporting.
InvoiceCodestring · nullable
Formatted identifier.
IsDeletedboolean
Soft delete flag for the order.
IsRecurringboolean
Indicates whether this order is a recurring payment (auto-renewal or subscription).
MainOrderIdinteger
Identifier of the related main order.
MemberIdinteger
The CRM Contact who submitted the Order (this field is not editable).
OrderNamestring · nullable
The Order name is generally constructed by the name of the Form used for taking the Order then appended with the Order date.
PaymentStateenum
Current payment status. Possible values: None, Succeeded, RequiresCapture, RequiresAction, Canceled, Processing, Pending.Possible values: NoneSucceededRequiresCaptureRequiresActionCanceledProcessingPending
StatusIdinteger
The current status of the Order. See eCommerce Settings / Manage Status for more details.
TotalCostnumber
The total amount or the Order (this field is not editable).
CreatedDateTimestring · date-time
Date-time - the date and time the Order was created in the CRM (this field is not editable). Read-only.
HasSubscriptionsboolean
Indicates whether the order contains at least one product that is a subscription (for example, access to a service for a month).
HasPaidSubscriptionboolean
Indicates whether this order was successfully paid for as part of a subscription.
TrackingURLstring · nullable
Intended for the URL used for consignment tracking by your freight provider.
TransactionIdstring · nullable
Unique transaction identifier from the payment gateway.
AmountPaidnumber
The amount that has already been actually received by the system. When it equals TotalCost, the order is considered fully paid.
AmountPendingnumber
An amount that is pending (for example, a bank transfer that has not yet been confirmed or a card hold).
OrderCaseTypeenum
Order category for internal processing. Possible values: FormCase, EventCase, None.Possible values: FormCaseEventCaseNone
StatusShortobject
This is a mapping object that decodes the system StatusId.
Idinteger
'Member' a unique user identifier in the system. Read-only.
Namestring · nullable
'ShippingInfo' recipient's name.
Typestring · nullable
'StatusShort' technical key (alias).
Discountobject
Discount amount (promotional codes, promotions).
Codestring · nullable
The code a customer enters at checkout to apply this discount.
Costnumber
'ShippingInfo' the cost of delivery services. Added to the cost of goods to form TotalCost.
GiftVoucherobject
Amount paid with a gift certificate.
Namestring · nullable
'ShippingInfo' recipient's name.
Costnumber
'ShippingInfo' the cost of delivery services. Added to the cost of goods to form TotalCost.
Taxobject
Tax amount. May be included in the price or added on top depending on the region.
Codestring · nullable
The identifier of the tax rule applied to the order.
Ratenumber
The tax rate applied, expressed as a percentage.
ShippingInfoobject
This is an object that contains detailed information about logistics and delivery address.
Namestring · nullable
'ShippingInfo' recipient's name.
Costnumber
'ShippingInfo' the cost of delivery services. Added to the cost of goods to form TotalCost.
Addressstring · nullable
'ShippingInfo' the contact's shipping address line (unit/number and street) as entered during the checkout process.
Citystring · nullable
'ShippingInfo' the contact's shipping city/suburb/provence as entered during the checkout process.
Statestring · nullable
'ShippingInfo' the contact's shipping state/territory as entered during the checkout process.
Zipcodestring · nullable
'ShippingInfo' the contact's shipping zipcode/postcode as entered during the checkout process.
Countrystring · nullable
'ShippingInfo' the contact's shipping country as entered during the checkout process.
Memberobject
Contains basic information about the customer who placed the order.
Idinteger
'Member' a unique user identifier in the system. Read-only.
Emailstring · nullable
'Member' contact email to which notifications about order status and invoices are sent.
FirstNamestring · nullable
'Member' buyer's name.
LastNamestring · nullable
'Member' buyer's last name.
MemberSnapshotobject
A frozen copy of the customer's details as they were when the order was placed, preserved even if the contact later changes.
Emailstring · nullable
'Member' contact email to which notifications about order status and invoices are sent.
FirstNamestring · nullable
'Member' buyer's name.
LastNamestring · nullable
'Member' buyer's last name.
BillingAddressstring · nullable
The billing street address captured on the order at the time it was placed.
BillingCitystring · nullable
The billing city captured on the order at the time it was placed.
BillingStatestring · nullable
The billing state or region captured on the order at the time it was placed.
BillingZipCodestring · nullable
The billing postal code captured on the order at the time it was placed.
BillingCountrystring · nullable
The billing country captured on the order at the time it was placed.
OrderLinesarray of objects
List of product items in the order.
Idinteger
'Member' a unique user identifier in the system. Read-only.
EntityTypeenum
Entity type. Possible values: Form, ModuleItem, SecureZoneSubscription.Possible values: FormModuleItemSecureZoneSubscription
ProductIdinteger
Unique system identifier of the product. Used to synchronize inventory balances.
ModuleIdinteger
The ID of the module or plugin responsible for this product type.
ProductNamestring · nullable
Product name that will be displayed in the order.
Quantityinteger
The number of units of a product that the customer purchases.
TaxRatenumber
The percentage tax rate that applies to this specific product.
UnitPricenumber
Price per unit of product at the time of order placement.
TotalPricenumber
Total cost of the linece per unit of product at the time of order placement.
FileNamestring · nullable
File name, if this line applies to a digital product.
IsDownloadboolean
A flag indicating whether this item is a downloadable file.
Attributesarray of objects
An array of additional characteristics (variations) of the selected product.
AttributeIdinteger
Identifier of the related attribute.
OptionsIdsarray of strings
List of selected values for this attribute.
Paymentsarray of objects
Transaction history for this order. Allows you to track multiple payment attempts (for example, if the first was declined and the second was successful). Contains payment details and dates.
Idinteger
'Member' a unique user identifier in the system. Read-only.
Amountnumber
This is a numeric value.
AmountCapturednumber
The amount that was actually written off.
GatewayReasonstring · nullable
Response or status code from the payment gateway.
TransactionIdstring · nullable
Unique transaction identifier from the payment gateway.
Statusstring · nullable
Current status of the operation.
PaymentTypeenum
Payment method. Possible values: CreditCard, Cash, Free, Paypal, Cheque, EFT, MoneyOrder, Other, Refund.Possible values: CreditCardCashFreePaypalChequeEFTMoneyOrderOtherRefund
PaymentGatewayTypeenum
Current status of the operation. Possible values: stripe, eway, paypal, bamboraEU, authorizeNet, paypalFlow, stripeElements, braintree.Possible values: stripeewaypaypalbamboraEUauthorizeNetpaypalFlowstripeElementsbraintree
Notesstring · nullable
Free text comment for the payment. Here you can specify the transaction number from the payment system.
CreatedDateTimestring · date-time
Date-time - the date and time the Order was created in the CRM (this field is not editable). Read-only.
CustomCrmGroupsarray of objects
JSON object for custom CRM metadata. Used to group customers or orders by specific marketing tags (e.g. "VIP", "Black Friday Hunter").
Aliasstring · nullable
System alias of the form.
Fieldsarray of objects
The individual field values stored in this CRM group.
Aliasstring · nullable
System alias of the form.
Valuestring · nullable
The value entered for this CRM field.
Typeenum
'StatusShort' technical key (alias). Possible values: DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Recaptcha, Upload, Password, AcceptPayment, AcceptEventSubscription, IsDataUsingAllowed, Country, HiddenValidator.Possible values: DateTimeCheckboxListDropdownListListboxListRadioListMultilineStringBooleanRecaptchaUploadPasswordAcceptPaymentAcceptEventSubscriptionIsDataUsingAllowedCountryHiddenValidator
curl -X PUT "https://your-site.webinone.com/api/v2/admin/orders/order-lines/1" \ -H "Authorization: Bearer <token>" \ -H "Content-Type: application/json" \ -d '{"ProductId":"string","ProductName":"Example","Quantity":0,"UnitPrice":0}'
await fetch("https://your-site.webinone.com/api/v2/admin/orders/order-lines/1", { method: "PUT", headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" }, body: JSON.stringify({ "ProductId": "string", "ProductName": "Example", "Quantity": 0, "UnitPrice": 0 }) });
import requests requests.put( "https://your-site.webinone.com/api/v2/admin/orders/order-lines/1", headers={"Authorization": "Bearer <token>"}, json={ "ProductId": "string", "ProductName": "Example", "Quantity": 0, "UnitPrice": 0 } )
$client = new GuzzleHttp\Client(); $response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/orders/order-lines/1', [ 'headers' => [ 'Authorization' => 'Bearer <token>', 'Content-Type' => 'application/json' ], 'json' => [ 'ProductId' => 'string', 'ProductName' => 'Example', 'Quantity' => 0, 'UnitPrice' => 0 ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/orders/order-lines/1"); request.Headers.Add("Authorization", "Bearer <token>"); request.Content = new StringContent( "{\"ProductId\":\"string\",\"ProductName\":\"Example\",\"Quantity\":0,\"UnitPrice\":0}", Encoding.UTF8, "application/json"); var response = await client.SendAsync(request);
Response · 200
{
"Id": 1,
"AWBNumber": "string",
"CurrencyCountry": "USD",
"Currency": "USD",
"Country": "string",
"InvoiceDate": "2026-07-01T00: 00: 00Z",
"InvoiceNumber": 0,
"VATInvoiceNumber": 0,
"InvoiceCode": "string",
"IsDeleted": false,
"IsRecurring": false,
"MainOrderId": 1,
"MemberId": 1,
"OrderName": "Example",
"PaymentState": "None",
"StatusId": 1,
"TotalCost": 0,
"CreatedDateTime": "2026-07-01T00: 00: 00Z",
"HasSubscriptions": false,
"HasPaidSubscription": false,
"TrackingURL": "https://example.com",
"TransactionId": "string",
"AmountPaid": 1,
"AmountPending": 0,
"OrderCaseType": "FormCase",
"StatusShort": {
"Id": 1,
"Name": "Example",
"Type": "string"
},
"Discount": {
"Code": "string",
"Cost": 0
},
"GiftVoucher": {
"Name": "Example",
"Cost": 0
},
"Tax": {
"Code": "string",
"Rate": 0
},
"ShippingInfo": {
"Name": "Example",
"Cost": 0,
"Address": "string",
"City": "string",
"State": "string",
"Zipcode": "string",
"Country": "string"
},
"Member": {
"Id": 1,
"Email": "user@example.com",
"FirstName": "Example",
"LastName": "Example"
},
"MemberSnapshot": {
"Email": "user@example.com",
"FirstName": "Example",
"LastName": "Example",
"BillingAddress": "string",
"BillingCity": "string",
"BillingState": "string",
"BillingZipCode": "string",
"BillingCountry": "string"
},
"OrderLines": [
{
"Id": 1,
"EntityType": "Form",
"ProductId": 1,
"ModuleId": 1,
"ProductName": "Example",
"Quantity": 0,
"TaxRate": 0,
"UnitPrice": 0,
"TotalPrice": 0,
"FileName": "Example",
"IsDownload": false,
"Attributes": [
{
"AttributeId": 1,
"OptionsIds": [
"string"
]
}
]
}
],
"Payments": [
{
"Id": 1,
"Amount": 0,
"AmountCaptured": 0,
"GatewayReason": "string",
"TransactionId": "string",
"Status": "string",
"PaymentType": "CreditCard",
"PaymentGatewayType": "stripe",
"Notes": "string",
"CreatedDateTime": "2026-07-01T00: 00: 00Z"
}
],
"CustomCrmGroups": [
{
"Alias": "string",
"Fields": [
{
"Alias": "string",
"Value": "string",
"Type": "DateTime"
}
]
}
]
}Deletes an existing order line
Parameters
idinteger · pathrequired
Existent order line id.
curl -X DELETE "https://your-site.webinone.com/api/v2/admin/orders/order-lines/1" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/orders/order-lines/1", { method: "DELETE", headers: { "Authorization": "Bearer <token>" } });
import requests requests.delete( "https://your-site.webinone.com/api/v2/admin/orders/order-lines/1", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('DELETE', 'https://your-site.webinone.com/api/v2/admin/orders/order-lines/1', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Delete, "https://your-site.webinone.com/api/v2/admin/orders/order-lines/1"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);