Open API v2 / CRM & Orders / CRM Order Statuses

CRM Order Statuses

→

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/order-statuses#

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

Unique identifier. Technical record number in the database. Read-only.

EmailIdinteger

The ID of the email template (Email Template) that will be automatically sent to the customer when the order transitions to this status.

NotifyCustomerboolean

If true, the customer will receive a notification about the order status change.

IsSystemboolean

Indicates whether the status is system (default).

Namestring · nullable

Name of the order status full.

Typeenum

Technical status code. Possible values: New, AwaitingPayment, Paid, PaymentFailed, PaymentCanceled, PendingCharge, Custom, ReturnRequested, PartiallyRefunded, Refunded.Possible values: NewAwaitingPaymentPaidPaymentFailedPaymentCanceledPendingChargeCustomReturnRequestedPartiallyRefundedRefunded

TypeDisplayNamestring · nullable

Text that the user sees instead of the technical code Type.

Workflowsarray of integers

An array of identifiers of automatic processes that are launched with this status.

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

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

import requests

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

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

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

Response · 200

{
  "Items": [
    {
      "Id": 1,
      "EmailId": 1,
      "NotifyCustomer": false,
      "IsSystem": false,
      "Name": "Example",
      "Type": "New",
      "TypeDisplayName": "Example",
      "Workflows": [
        0
      ]
    }
  ],
  "TotalItemsCount": 0
}

POST/api/v2/admin/orders/order-statuses#

Creates a new order status

Body parameters

Namestringrequired

Status name that the administrator and the client see.

NotifyCustomerboolean

If true, the system will automatically send the customer a notification that the status of their order has changed.

Workflowsarray of strings

Array of business process identifiers or names.

Response

Idinteger

Unique identifier. Technical record number in the database. Read-only.

EmailIdinteger

The ID of the email template (Email Template) that will be automatically sent to the customer when the order transitions to this status.

NotifyCustomerboolean

If true, the customer will receive a notification about the order status change.

IsSystemboolean

Indicates whether the status is system (default).

Namestring · nullable

Name of the order status full.

Typeenum

TypeDisplayNamestring · nullable

Text that the user sees instead of the technical code Type.

Workflowsarray of integers

An array of identifiers of automatic processes that are launched with this status.

curl -X POST "https://your-site.webinone.com/api/v2/admin/orders/order-statuses" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"Name":"Example","NotifyCustomer":false,"Workflows":["string"]}'

await fetch("https://your-site.webinone.com/api/v2/admin/orders/order-statuses", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "Name": "Example",
    "NotifyCustomer": false,
    "Workflows": [
      "string"
    ]
  })
});

import requests

requests.post(
    "https://your-site.webinone.com/api/v2/admin/orders/order-statuses",
    headers={"Authorization": "Bearer <token>"},
    json={
        "Name": "Example",
        "NotifyCustomer": False,
        "Workflows": ["string"]
    }
)

$client = new GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/orders/order-statuses', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
        'Content-Type' => 'application/json'
    ],
    'json' => [
        'Name' => 'Example',
        'NotifyCustomer' => false,
        'Workflows' => ['string']
    ]
]);

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/orders/order-statuses");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"Name\":\"Example\",\"NotifyCustomer\":false,\"Workflows\":[\"string\"]}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

Response · 200

{
  "Id": 1,
  "EmailId": 1,
  "NotifyCustomer": false,
  "IsSystem": false,
  "Name": "Example",
  "Type": "New",
  "TypeDisplayName": "Example",
  "Workflows": [
    0
  ]
}

GET/api/v2/admin/orders/order-statuses/{id}#

Retrieves a single order status

Parameters

idinteger · pathrequired

Order status id.

Response

Idinteger

Unique identifier. Technical record number in the database. Read-only.

EmailIdinteger

The ID of the email template (Email Template) that will be automatically sent to the customer when the order transitions to this status.

NotifyCustomerboolean

If true, the customer will receive a notification about the order status change.

IsSystemboolean

Indicates whether the status is system (default).

Namestring · nullable

Name of the order status full.

Typeenum

TypeDisplayNamestring · nullable

Text that the user sees instead of the technical code Type.

Workflowsarray of integers

An array of identifiers of automatic processes that are launched with this status.

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

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

import requests

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

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

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

Response · 200

{
  "Id": 1,
  "EmailId": 1,
  "NotifyCustomer": false,
  "IsSystem": false,
  "Name": "Example",
  "Type": "New",
  "TypeDisplayName": "Example",
  "Workflows": [
    0
  ]
}

PUT/api/v2/admin/orders/order-statuses/{id}#

Updates an existing order status

Parameters

idinteger · pathrequired

Existent order status id.

Body parameters

Namestringrequired

Status name that the administrator and the client see.

NotifyCustomerboolean

If true, the system will automatically send the customer a notification that the status of their order has changed.

Workflowsarray of strings

Array of business process identifiers or names.

Response

Idinteger

Unique identifier. Technical record number in the database. Read-only.

EmailIdinteger

The ID of the email template (Email Template) that will be automatically sent to the customer when the order transitions to this status.

NotifyCustomerboolean

If true, the customer will receive a notification about the order status change.

IsSystemboolean

Indicates whether the status is system (default).

Namestring · nullable

Name of the order status full.

Typeenum

TypeDisplayNamestring · nullable

Text that the user sees instead of the technical code Type.

Workflowsarray of integers

An array of identifiers of automatic processes that are launched with this status.

curl -X PUT "https://your-site.webinone.com/api/v2/admin/orders/order-statuses/1" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"Name":"Example","NotifyCustomer":false,"Workflows":["string"]}'

await fetch("https://your-site.webinone.com/api/v2/admin/orders/order-statuses/1", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "Name": "Example",
    "NotifyCustomer": false,
    "Workflows": [
      "string"
    ]
  })
});

import requests

requests.put(
    "https://your-site.webinone.com/api/v2/admin/orders/order-statuses/1",
    headers={"Authorization": "Bearer <token>"},
    json={
        "Name": "Example",
        "NotifyCustomer": False,
        "Workflows": ["string"]
    }
)

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

using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/orders/order-statuses/1");
request.Headers.Add("Authorization", "Bearer <token>");
request.Content = new StringContent(
    "{\"Name\":\"Example\",\"NotifyCustomer\":false,\"Workflows\":[\"string\"]}",
    Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);

Response · 200

{
  "Id": 1,
  "EmailId": 1,
  "NotifyCustomer": false,
  "IsSystem": false,
  "Name": "Example",
  "Type": "New",
  "TypeDisplayName": "Example",
  "Workflows": [
    0
  ]
}

DELETE/api/v2/admin/orders/order-statuses/{id}#

Deletes an existing order status

Parameters

idinteger · pathrequired

Existent order status id.

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

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

import requests

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

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

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