Open API v2 / CRM & Orders / CRM Orders Trash
CRM Orders Trash
→
Every request needs a bearer token: Authorization: Bearer <token>. Base URL https://your-site.webinone.com. New to field types? See the type reference.
Retrieves a list of trashed orders by using a "where" filtering
Parameters
Wherestring · query
JSON filter expression. Combine operators ($eq, $contains, $gt, $in, …) with $and / $or.
Order_Bystring · query
Sort field. Prefix with - for descending; comma-separate for tie-breakers.
Semantic_Querystring · query
Natural-language search, ranked by relevance.
Min_Scorenumber · query
Lowest relevance score to include when using Semantic_Query.
Offsetinteger · query
Number of items to skip before returning results. Defaults to 0.
Limitinteger · query
Maximum number of items to return. Defaults to 100.
Response
MovedToTrashDateTimestring · date-time
Moved to trash timestamp (ISO 8601).
Idinteger
Unique identifier assigned by the platform.
AWBNumberstring · nullable
The Air Waybill or shipment tracking number from the freight provider, preserved on the trashed order.
CurrencyCountrystring · nullable
The currency and country pair used for payment processing on this order.
Currencystring · nullable
Currency code (e.g. USD).
Countrystring · nullable
Country (it is recommended to use ISO codes).
InvoiceDatestring · date-time
The date and time the invoice was generated for this order.
InvoiceNumberinteger · nullable
The invoice number assigned incrementally to this order.
VATInvoiceNumberinteger · nullable
The VAT invoice number assigned to this order for tax reporting.
InvoiceCodestring · nullable
The formatted invoice identifier for this order.
IsDeletedboolean
Whether the order is soft-deleted.
IsRecurringboolean
Whether the order is a recurring payment, such as an auto-renewal or subscription. True means the system created it automatically from a previous order. False means the customer placed it directly.
MainOrderIdinteger
Identifier of the related main order.
MemberIdinteger
Identifier of the related member.
OrderNamestring · nullable
The order name, usually built from the form used to place it plus the order date.
PaymentStateenum
The current payment status of the order. Possible values: None, Succeeded, RequiresCapture, RequiresAction, Canceled, Processing, Pending.Possible values: NoneSucceededRequiresCaptureRequiresActionCanceledProcessingPending
StatusIdinteger
Identifier of the related status.
TotalCostnumber
The total amount of the order.
CreatedDateTimestring · date-time
When the record was created (ISO 8601). Read-only.
HasSubscriptionsboolean
Whether the order contains at least one subscription product, such as timed access to a service.
HasPaidSubscriptionboolean
Whether a subscription in this order was successfully paid for.
TrackingURLstring · nullable
The consignment tracking URL from the freight provider, for use in order and invoice emails.
TransactionIdstring · nullable
Identifier of the related transaction.
AmountPaidnumber
Identifier of the related amount pa.
AmountPendingnumber
The amount still awaiting confirmation, such as an unconfirmed bank transfer or a card hold.
OrderCaseTypeenum
The category of the order for internal processing. Possible values: FormCase, EventCase, None.Possible values: FormCaseEventCaseNone
StatusShortobject
A compact object that decodes the numeric StatusId into a readable status name and technical key.
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
The gift voucher applied to the order, including the amount paid with it.
Namestring · nullable
'ShippingInfo' recipient's name.
Costnumber
'ShippingInfo' the cost of delivery services. Added to the cost of goods to form TotalCost.
Taxobject
The tax applied to the order, which 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
The logistics and delivery details for the order, including recipient name, shipping cost, and 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
Basic details of 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.
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
The list of product line 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
The transaction history for the order, tracking each payment attempt with its details and date.
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
Custom CRM metadata attached to the order, used to group orders or customers by tags such as VIP or 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 "https://your-site.webinone.com/api/v2/admin/orders/trash" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/orders/trash", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/orders/trash", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/orders/trash', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/orders/trash"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
{
"Items": [
{
"MovedToTrashDateTime": "2026-07-01T00: 00: 00Z",
"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": null
}
]
}
],
"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"
}
]
}
]
}
],
"TotalItemsCount": 0
}Permanently deletes an order from trash
Parameters
idinteger · pathrequired
Order id to permanently delete.
curl -X DELETE "https://your-site.webinone.com/api/v2/admin/orders/trash/1" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/orders/trash/1", { method: "DELETE", headers: { "Authorization": "Bearer <token>" } });
import requests requests.delete( "https://your-site.webinone.com/api/v2/admin/orders/trash/1", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('DELETE', 'https://your-site.webinone.com/api/v2/admin/orders/trash/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/trash/1"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Restores an order from trash
Parameters
idinteger · pathrequired
Order id to restore.
curl -X PUT "https://your-site.webinone.com/api/v2/admin/orders/trash/1/restore" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/orders/trash/1/restore", { method: "PUT", headers: { "Authorization": "Bearer <token>" } });
import requests requests.put( "https://your-site.webinone.com/api/v2/admin/orders/trash/1/restore", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/orders/trash/1/restore', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/orders/trash/1/restore"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);