Open API v2 / CRM & Orders / CRM Order Assets

CRM Order Assets

→

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

PUT/api/v2/admin/orders/{id}/discount-code#

Sets a discount code to an order

Parameters

idinteger · pathrequired

Resource identifier.

Body parameters

DiscountIdstring · nullable

Identifier of the related discount.

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 -X PUT "https://your-site.webinone.com/api/v2/admin/orders/1/discount-code" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"DiscountId":"string"}'

await fetch("https://your-site.webinone.com/api/v2/admin/orders/1/discount-code", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "DiscountId": "string"
  })
});

import requests

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

$client = new GuzzleHttp\Client();
$response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/orders/1/discount-code', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'DiscountId' => 'string'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/orders/1/discount-code");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"DiscountId\":\"string\"}",
    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"
        }
      ]
    }
  ]
}

PUT/api/v2/admin/orders/{id}/gift-voucher#

Sets a gift voucher to an order

Parameters

idinteger · pathrequired

Resource identifier.

Body parameters

GiftVoucherIdstring · nullable

Identifier of the related gift voucher.

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/gift-voucher" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"GiftVoucherId":"string"}'

await fetch("https://your-site.webinone.com/api/v2/admin/orders/1/gift-voucher", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "GiftVoucherId": "string"
  })
});

import requests

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

$client = new GuzzleHttp\Client();
$response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/orders/1/gift-voucher', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'GiftVoucherId' => 'string'
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/orders/1/gift-voucher");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"GiftVoucherId\":\"string\"}",
    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"
        }
      ]
    }
  ]
}

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

Sets a shipping option to an order

Parameters

idinteger · pathrequired

Resource identifier.

Body parameters

ShippingOptionIdstring · nullable

Identifier of the related shipping option.

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/shipping" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"ShippingOptionId":"string"}'

await fetch("https://your-site.webinone.com/api/v2/admin/orders/1/shipping", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "ShippingOptionId": "string"
  })
});

import requests

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

$client = new GuzzleHttp\Client();
$response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/orders/1/shipping', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'ShippingOptionId' => 'string'
    ]
]);

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

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

Sets a tax code to an order

Parameters

idinteger · pathrequired

Resource identifier.

Body parameters

TaxIdstring · nullable

Identifier of the related tax.

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/tax" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"TaxId":"string"}'

await fetch("https://your-site.webinone.com/api/v2/admin/orders/1/tax", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "TaxId": "string"
  })
});

import requests

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

$client = new GuzzleHttp\Client();
$response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/orders/1/tax', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'TaxId' => 'string'
    ]
]);

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