Open API v2 / CRM & Orders / CRM Orders

CRM Orders

→

Every request needs a bearer token: Authorization: Bearer <token>. Base URL https://your-site.webinone.com. New to field types? See the type reference.

GET/api/v2/admin/orders#

Retrieves a list of 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

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.

Discountobject

Discount amount (promotional codes, promotions).

GiftVoucherobject

Amount paid with a gift certificate.

Taxobject

Tax amount. May be included in the price or added on top depending on the region.

ShippingInfoobject

This is an object that contains detailed information about logistics and delivery address.

Memberobject

Contains basic information about the customer who placed the order.

MemberSnapshotobject

A frozen copy of the customer's details as they were when the order was placed, preserved even if the contact later changes.

OrderLinesarray of objects

List of product items in the order.

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.

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").

curl "https://your-site.webinone.com/api/v2/admin/orders" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/orders", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.get(
    "https://your-site.webinone.com/api/v2/admin/orders",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/orders', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/orders");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

Response · 200

{
  "Items": [
    {
      "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
}

POST/api/v2/admin/orders#

Creates a new order

Body parameters

AWBNumberstring · nullable

Intended for the Air Waybill (or any other shipment tracking/consignment number) from your freight provider.

InvoiceDatestring · date-time · nullable

Date-time - the date and time the invoice was generated.

InvoiceNumberinteger · nullable

A number assigned incrementally to each order.

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

StatusIdstring · nullable

The current status of the Order. See eCommerce Settings / Manage Status for more details.

TrackingURLstring · nullable

Intended for the URL used for consignment tracking by your freight provider.

ShippingZipCodestring · nullable

The contact's shipping zipcode/postcode as entered during the checkout process.

ShippingStatestring · nullable

The contact's shipping state/territory as entered during the checkout process.

ShippingAddressstring · nullable

The contact's shipping address line (unit/number and street) as entered during the checkout process.

ShippingCitystring · nullable

The contact's shipping city/suburb/provence as entered during the checkout process.

ShippingCountrystringrequired

The contact's shipping country as entered during the checkout process.

GenerateInvoiceNumberboolean

Request only. If true, the system will automatically generate an invoice number. Missing from the response.

GenerateVATInvoiceNumberboolean

When true, the system automatically assigns a VAT invoice number to the new order.

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

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.

Discountobject

Discount amount (promotional codes, promotions).

GiftVoucherobject

Amount paid with a gift certificate.

Taxobject

Tax amount. May be included in the price or added on top depending on the region.

ShippingInfoobject

This is an object that contains detailed information about logistics and delivery address.

Memberobject

Contains basic information about the customer who placed the order.

MemberSnapshotobject

A frozen copy of the customer's details as they were when the order was placed, preserved even if the contact later changes.

OrderLinesarray of objects

List of product items in the order.

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.

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").

curl -X POST "https://your-site.webinone.com/api/v2/admin/orders" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"AWBNumber":"string","InvoiceDate":"2026-07-01T00:00:00Z","InvoiceNumber":0,"MainOrderId":1,"MemberId":1,"OrderName":"Example","PaymentState":"None","StatusId":"string","TrackingURL":"https://example.com","ShippingZipCode":"string","ShippingState":"string","ShippingAddress":"string","ShippingCity":"string","ShippingCountry":"string","GenerateInvoiceNumber":false,"GenerateVATInvoiceNumber":false}'

await fetch("https://your-site.webinone.com/api/v2/admin/orders", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "AWBNumber": "string",
    "InvoiceDate": "2026-07-01T00:00:00Z",
    "InvoiceNumber": 0,
    "MainOrderId": 1,
    "MemberId": 1,
    "OrderName": "Example",
    "PaymentState": "None",
    "StatusId": "string",
    "TrackingURL": "https://example.com",
    "ShippingZipCode": "string",
    "ShippingState": "string",
    "ShippingAddress": "string",
    "ShippingCity": "string",
    "ShippingCountry": "string",
    "GenerateInvoiceNumber": false,
    "GenerateVATInvoiceNumber": false
  })
});

import requests

requests.post(
    "https://your-site.webinone.com/api/v2/admin/orders",
    headers={"Authorization": "Bearer <token>"},
    json={
        "AWBNumber": "string",
        "InvoiceDate": "2026-07-01T00:00:00Z",
        "InvoiceNumber": 0,
        "MainOrderId": 1,
        "MemberId": 1,
        "OrderName": "Example",
        "PaymentState": "None",
        "StatusId": "string",
        "TrackingURL": "https://example.com",
        "ShippingZipCode": "string",
        "ShippingState": "string",
        "ShippingAddress": "string",
        "ShippingCity": "string",
        "ShippingCountry": "string",
        "GenerateInvoiceNumber": False,
        "GenerateVATInvoiceNumber": False
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/orders', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'AWBNumber' => 'string',
        'InvoiceDate' => '2026-07-01T00:00:00Z',
        'InvoiceNumber' => 0,
        'MainOrderId' => 1,
        'MemberId' => 1,
        'OrderName' => 'Example',
        'PaymentState' => 'None',
        'StatusId' => 'string',
        'TrackingURL' => 'https://example.com',
        'ShippingZipCode' => 'string',
        'ShippingState' => 'string',
        'ShippingAddress' => 'string',
        'ShippingCity' => 'string',
        'ShippingCountry' => 'string',
        'GenerateInvoiceNumber' => false,
        'GenerateVATInvoiceNumber' => false
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/orders");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"AWBNumber\":\"string\",\"InvoiceDate\":\"2026-07-01T00:00:00Z\",\"InvoiceNumber\":0,\"MainOrderId\":1,\"MemberId\":1,\"OrderName\":\"Example\",\"PaymentState\":\"None\",\"StatusId\":\"string\",\"TrackingURL\":\"https://example.com\",\"ShippingZipCode\":\"string\",\"ShippingState\":\"string\",\"ShippingAddress\":\"string\",\"ShippingCity\":\"string\",\"ShippingCountry\":\"string\",\"GenerateInvoiceNumber\":false,\"GenerateVATInvoiceNumber\":false}",
    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"
        }
      ]
    }
  ]
}

GET/api/v2/admin/orders/{id}#

Retrieves a single order

Parameters

idinteger · pathrequired

Order id.

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

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.

Discountobject

Discount amount (promotional codes, promotions).

GiftVoucherobject

Amount paid with a gift certificate.

Taxobject

Tax amount. May be included in the price or added on top depending on the region.

ShippingInfoobject

This is an object that contains detailed information about logistics and delivery address.

Memberobject

Contains basic information about the customer who placed the order.

MemberSnapshotobject

A frozen copy of the customer's details as they were when the order was placed, preserved even if the contact later changes.

OrderLinesarray of objects

List of product items in the order.

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.

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").

curl "https://your-site.webinone.com/api/v2/admin/orders/1" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/orders/1", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.get(
    "https://your-site.webinone.com/api/v2/admin/orders/1",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/orders/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/1");
request.Headers.Add("Authorization", "Bearer <token>");
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"
        }
      ]
    }
  ]
}

PUT/api/v2/admin/orders/{id}#

Updates an existing order

Parameters

idinteger · pathrequired

Existent order id.

Body parameters

AWBNumberstring · nullable

Intended for the Air Waybill (or any other shipment tracking/consignment number) from your freight provider.

Currencystring · nullable

Currency code (e.g. USD).

Countrystring · nullable

Country (it is recommended to use ISO codes).

InvoiceDatestring · date-time · nullable

Date-time - the date and time the invoice was generated.

InvoiceNumberinteger · nullable

A number assigned incrementally to each order.

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

StatusIdstring · nullable

The current status of the Order. See eCommerce Settings / Manage Status for more details.

TrackingURLstring · nullable

Intended for the URL used for consignment tracking by your freight provider.

ShippingZipCodestring · nullable

The contact's shipping zipcode/postcode as entered during the checkout process.

ShippingStatestring · nullable

The contact's shipping state/territory as entered during the checkout process.

ShippingAddressstring · nullable

The contact's shipping address line (unit/number and street) as entered during the checkout process.

ShippingCitystring · nullable

The contact's shipping city/suburb/provence as entered during the checkout process.

ShippingCountrystringrequired

The contact's shipping country as entered during the checkout process.

GenerateInvoiceNumberboolean

Request only. If true, the system will automatically generate an invoice number. Missing from the response.

GenerateVATInvoiceNumberboolean

When true, the system automatically assigns a VAT invoice number to the order.

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

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.

Discountobject

Discount amount (promotional codes, promotions).

GiftVoucherobject

Amount paid with a gift certificate.

Taxobject

Tax amount. May be included in the price or added on top depending on the region.

ShippingInfoobject

This is an object that contains detailed information about logistics and delivery address.

Memberobject

Contains basic information about the customer who placed the order.

MemberSnapshotobject

A frozen copy of the customer's details as they were when the order was placed, preserved even if the contact later changes.

OrderLinesarray of objects

List of product items in the order.

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.

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").

curl -X PUT "https://your-site.webinone.com/api/v2/admin/orders/1" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"AWBNumber":"string","Currency":"USD","Country":"string","InvoiceDate":"2026-07-01T00:00:00Z","InvoiceNumber":0,"MainOrderId":1,"MemberId":1,"OrderName":"Example","PaymentState":"None","StatusId":"string","TrackingURL":"https://example.com","ShippingZipCode":"string","ShippingState":"string","ShippingAddress":"string","ShippingCity":"string","ShippingCountry":"string","GenerateInvoiceNumber":false,"GenerateVATInvoiceNumber":false}'

await fetch("https://your-site.webinone.com/api/v2/admin/orders/1", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "AWBNumber": "string",
    "Currency": "USD",
    "Country": "string",
    "InvoiceDate": "2026-07-01T00:00:00Z",
    "InvoiceNumber": 0,
    "MainOrderId": 1,
    "MemberId": 1,
    "OrderName": "Example",
    "PaymentState": "None",
    "StatusId": "string",
    "TrackingURL": "https://example.com",
    "ShippingZipCode": "string",
    "ShippingState": "string",
    "ShippingAddress": "string",
    "ShippingCity": "string",
    "ShippingCountry": "string",
    "GenerateInvoiceNumber": false,
    "GenerateVATInvoiceNumber": false
  })
});

import requests

requests.put(
    "https://your-site.webinone.com/api/v2/admin/orders/1",
    headers={"Authorization": "Bearer <token>"},
    json={
        "AWBNumber": "string",
        "Currency": "USD",
        "Country": "string",
        "InvoiceDate": "2026-07-01T00:00:00Z",
        "InvoiceNumber": 0,
        "MainOrderId": 1,
        "MemberId": 1,
        "OrderName": "Example",
        "PaymentState": "None",
        "StatusId": "string",
        "TrackingURL": "https://example.com",
        "ShippingZipCode": "string",
        "ShippingState": "string",
        "ShippingAddress": "string",
        "ShippingCity": "string",
        "ShippingCountry": "string",
        "GenerateInvoiceNumber": False,
        "GenerateVATInvoiceNumber": False
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/orders/1', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'AWBNumber' => 'string',
        'Currency' => 'USD',
        'Country' => 'string',
        'InvoiceDate' => '2026-07-01T00:00:00Z',
        'InvoiceNumber' => 0,
        'MainOrderId' => 1,
        'MemberId' => 1,
        'OrderName' => 'Example',
        'PaymentState' => 'None',
        'StatusId' => 'string',
        'TrackingURL' => 'https://example.com',
        'ShippingZipCode' => 'string',
        'ShippingState' => 'string',
        'ShippingAddress' => 'string',
        'ShippingCity' => 'string',
        'ShippingCountry' => 'string',
        'GenerateInvoiceNumber' => false,
        'GenerateVATInvoiceNumber' => false
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/orders/1");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"AWBNumber\":\"string\",\"Currency\":\"USD\",\"Country\":\"string\",\"InvoiceDate\":\"2026-07-01T00:00:00Z\",\"InvoiceNumber\":0,\"MainOrderId\":1,\"MemberId\":1,\"OrderName\":\"Example\",\"PaymentState\":\"None\",\"StatusId\":\"string\",\"TrackingURL\":\"https://example.com\",\"ShippingZipCode\":\"string\",\"ShippingState\":\"string\",\"ShippingAddress\":\"string\",\"ShippingCity\":\"string\",\"ShippingCountry\":\"string\",\"GenerateInvoiceNumber\":false,\"GenerateVATInvoiceNumber\":false}",
    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"
        }
      ]
    }
  ]
}

DELETE/api/v2/admin/orders/{id}#

Deletes an existing order

Parameters

idinteger · pathrequired

Existent order id.

curl -X DELETE "https://your-site.webinone.com/api/v2/admin/orders/1" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/orders/1", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.delete(
    "https://your-site.webinone.com/api/v2/admin/orders/1",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('DELETE', 'https://your-site.webinone.com/api/v2/admin/orders/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/1");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

PUT/api/v2/admin/orders/{id}/custom-crm-groups#

Updates an existing order custom crm group data

Parameters

idinteger · pathrequired

Existent order id.

curl -X PUT "https://your-site.webinone.com/api/v2/admin/orders/1/custom-crm-groups" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/orders/1/custom-crm-groups", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.put(
    "https://your-site.webinone.com/api/v2/admin/orders/1/custom-crm-groups",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/orders/1/custom-crm-groups', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/orders/1/custom-crm-groups");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

PUT/api/v2/admin/orders/{id}/generate-invoice-number#

Generate invoice number for order

Parameters

idinteger · pathrequired

Existent order id.

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

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.

Discountobject

Discount amount (promotional codes, promotions).

GiftVoucherobject

Amount paid with a gift certificate.

Taxobject

Tax amount. May be included in the price or added on top depending on the region.

ShippingInfoobject

This is an object that contains detailed information about logistics and delivery address.

Memberobject

Contains basic information about the customer who placed the order.

MemberSnapshotobject

A frozen copy of the customer's details as they were when the order was placed, preserved even if the contact later changes.

OrderLinesarray of objects

List of product items in the order.

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.

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").

curl -X PUT "https://your-site.webinone.com/api/v2/admin/orders/1/generate-invoice-number" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/orders/1/generate-invoice-number", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.put(
    "https://your-site.webinone.com/api/v2/admin/orders/1/generate-invoice-number",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/orders/1/generate-invoice-number', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/orders/1/generate-invoice-number");
request.Headers.Add("Authorization", "Bearer <token>");
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"
        }
      ]
    }
  ]
}

PUT/api/v2/admin/orders/{id}/generate-vat-invoice-number#

Generate VAT invoice number for order

Parameters

idinteger · pathrequired

Existent order id.

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

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.

Discountobject

Discount amount (promotional codes, promotions).

GiftVoucherobject

Amount paid with a gift certificate.

Taxobject

Tax amount. May be included in the price or added on top depending on the region.

ShippingInfoobject

This is an object that contains detailed information about logistics and delivery address.

Memberobject

Contains basic information about the customer who placed the order.

MemberSnapshotobject

A frozen copy of the customer's details as they were when the order was placed, preserved even if the contact later changes.

OrderLinesarray of objects

List of product items in the order.

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.

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").

curl -X PUT "https://your-site.webinone.com/api/v2/admin/orders/1/generate-vat-invoice-number" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/orders/1/generate-vat-invoice-number", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.put(
    "https://your-site.webinone.com/api/v2/admin/orders/1/generate-vat-invoice-number",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/orders/1/generate-vat-invoice-number', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/orders/1/generate-vat-invoice-number");
request.Headers.Add("Authorization", "Bearer <token>");
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"
        }
      ]
    }
  ]
}

GET/api/v2/admin/orders/{id}/snapshot#

Retrieves customer snapshot data for an order

Parameters

idinteger · pathrequired

Order id.

Response

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.

curl "https://your-site.webinone.com/api/v2/admin/orders/1/snapshot" \
  -H "Authorization: Bearer <token>"

await fetch("https://your-site.webinone.com/api/v2/admin/orders/1/snapshot", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

import requests

requests.get(
    "https://your-site.webinone.com/api/v2/admin/orders/1/snapshot",
    headers={"Authorization": "Bearer <token>"}
)

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/orders/1/snapshot', [
    'headers' => [
        'Authorization' => 'Bearer <token>'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/orders/1/snapshot");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);

Response · 200

{
  "Email": "user@example.com",
  "FirstName": "Example",
  "LastName": "Example",
  "BillingAddress": "string",
  "BillingCity": "string",
  "BillingState": "string",
  "BillingZipCode": "string",
  "BillingCountry": "string"
}