Introduction
ATUM 1.8.8+ is fully integrated with the WooCommerce and WordPress REST APIs. This allows ATUM data to be created, read, updated, and deleted using requests in JSON format and using WordPress REST API Authentication methods and standard HTTP verbs which are understood by most HTTP clients.
The current WP REST API integration version is v3 which takes a first-order position in endpoints.
The following table shows API versions present in each major version of WooCommerce:
| API Version | ATUM Version | WC Version | WP Version |
|---|---|---|---|
v3 |
1.8.8 or later | 3.6.0 or later | 5.0 or later |
These API Docs are restricted to ATUM data, if you want to read docs for the other WC endpoints, we suggest you read the WC REST API Docs.
Some of the endpoints described on these docs are just the ones described in the WC's official API docs but with extra info regarding ATUM data. The data added by ATUM to the official WC's endpoints can be identified in these docs with the label: ATUM.
There is info described here that it's ony available when some of the ATUM's premium add-ons are active. We'll identify them with orange labels like Multi-Inventory or Product Levels.
Requirements
To use the latest version of the REST API you must be using:
- ATUM Inventory Management for WooCommerce 1.8.8+.
- WooCommerce 3.6+.
- WordPress 5.0+.
- Pretty permalinks in
Settings > Permalinksso that the custom endpoints are supported. Default permalinks will not work. - You may access the API over either HTTP or HTTPS, but HTTPS is recommended where possible.
If you use ModSecurity and see 501 Method Not Implemented errors, see this issue for details.
Request/Response Format
The default response format is JSON. Requests with a message-body use plain JSON to set or update resource attributes. Successful requests will return a 200 OK HTTP status.
Some general information about responses:
- Dates are returned in ISO8601 format:
YYYY-MM-DDTHH:MM:SS - Resource IDs are returned as integers.
- Other amounts, such as item counts, are returned as integers.
- Blank fields are generally included as
nullor emtpy string instead of being omitted.
JSONP Support
The WP REST API supports JSONP by default. JSONP responses use the application/javascript content-type. You can specify the callback using the ?_jsonp parameter for GET requests to have the response wrapped in a JSON function:
GET
/wp-json/wc/v3?_jsonp=callback
curl https://example.com/wp-json/wc/v3/products/tags/34?_jsonp=tagDetails \
-u consumer_key:consumer_secret
WooCommerce.get("products/tags/34?_jsonp=tagDetails")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('products/tags/34', ['_jsonp' => 'tagDetails'])); ?>
print(wcapi.get("products/tags/34?_jsonp=tagDetails").json())
woocommerce.get("products/tags/34", _jsonp: "tagDetails").parsed_response
Response:
/**/tagDetails({"id":34,"name":"Leather Shoes","slug":"leather-shoes","description":"","count":0,"_links":{"self":[{"href":"https://example.com/wp-json/wc/v3/products/tags/34"}],"collection":[{"href":"https://example.com/wp-json/wc/v3/products/tags"}]}})%
Errors
Occasionally you might encounter errors when accessing the REST API. There are four possible types:
| Error Code | Error Type |
|---|---|
400 Bad Request |
Invalid request, e.g. using an unsupported HTTP method |
401 Unauthorized |
Authentication or permission error, e.g. incorrect API keys |
404 Not Found |
Requests to resources that don't exist or are missing |
500 Internal Server Error |
Server error |
WP REST API error example:
{
"code": "rest_no_route",
"message": "No route was found matching the URL and request method",
"data": {
"status": 404
}
}
WooCommerce REST API error example:
{
"code": "woocommerce_rest_term_invalid",
"message": "Resource doesn't exist.",
"data": {
"status": 404
}
}
ATUM REST API error example:
{
"code": "atum_rest_term_invalid",
"message": "Resource doesn't exist.",
"data": {
"status": 404
}
}
Errors return both an appropriate HTTP status code and response object which contains a code, message and data attribute.
Parameters
Almost all endpoints accept optional parameters which can be passed as a HTTP query string parameter, e.g. GET /orders?status=completed. All parameters are documented along each endpoint.
Pagination
Requests that return multiple items will be paginated to 10 items by default. This default can be changed by the site administrator by changing the posts_per_page option. Alternatively the items per page can be specified with the ?per_page parameter:
GET /atum/purchase-orders?per_page=15
You can specify further pages with the ?page parameter:
GET /atum/purchase-orders?page=2
You may also specify the offset from the first resource using the ?offset parameter:
GET /atum/purchase-orders?offset=5
Page number is 1-based and omitting the ?page parameter will return the first page.
The total number of resources and pages are always included in the X-WP-Total and X-WP-TotalPages HTTP headers.
Link Header
Pagination info is included in the Link Header. It's recommended that you follow these values instead of building your own URLs where possible.
Link: <https://www.example.com/wp-json/wc/v3/products?page=2>; rel="next",
<https://www.example.com/wp-json/wc/v3/products?page=3>; rel="last"`
The possible rel values are:
| Value | Description |
|---|---|
next |
Shows the URL of the immediate next page of results. |
last |
Shows the URL of the last page of results. |
first |
Shows the URL of the first page of results. |
prev |
Shows the URL of the immediate previous page of results. |
Libraries and Tools
Official WooCommerce libraries
- JavaScript Library
- PHP Library
- Python Library
- Ruby Library
// Install:
// npm install --save @woocommerce/woocommerce-rest-api
// Setup:
const WooCommerceRestApi = require("@woocommerce/woocommerce-rest-api").default;
// import WooCommerceRestApi from "@woocommerce/woocommerce-rest-api"; // Supports ESM
const WooCommerce = new WooCommerceRestApi({
url: 'http://example.com', // Your store URL
consumerKey: 'consumer_key', // Your consumer key
consumerSecret: 'consumer_secret', // Your consumer secret
version: 'wc/v3' // WooCommerce WP REST API version
});
<?php
// Install:
// composer require automattic/woocommerce
// Setup:
require __DIR__ . '/vendor/autoload.php';
use Automattic\WooCommerce\Client;
$woocommerce = new Client(
'http://example.com', // Your store URL
'consumer_key', // Your consumer key
'consumer_secret', // Your consumer secret
[
'wp_api' => true, // Enable the WP REST API integration
'version' => 'wc/v3' // WooCommerce WP REST API version
]
);
?>
# Install:
# pip install woocommerce
# Setup:
from woocommerce import API
wcapi = API(
url="http://example.com", # Your store URL
consumer_key="consumer_key", # Your consumer key
consumer_secret="consumer_secret", # Your consumer secret
wp_api=True, # Enable the WP REST API integration
version="wc/v3" # WooCommerce WP REST API version
)
# Install:
# gem install woocommerce_api
# Setup:
require "woocommerce_api"
woocommerce = WooCommerce::API.new(
"https://example.com", # Your store URL
"consumer_key", # Your consumer key
"consumer_secret", # Your consumer secret
{
wp_api: true, # Enable the WP REST API integration
version: "wc/v3" # WooCommerce WP REST API version
}
)
Third party libraries
API Tools
Some useful tools you can use to access the API include:
- Postman - Cross-platform REST client, available for Mac, Windows, and Linux.
- Insomnia - Cross-platform GraphQL and REST client, available for Mac, Windows, and Linux.
- RequestBin - Allows you test webhooks.
- Hookbin - Another tool to test webhooks.
Learn more
Learn more about the REST API checking the official WordPress REST API documentation.
Authentication
WooCommerce includes two ways to authenticate with the WP REST API. It is also possible to authenticate using any WP REST API authentication plugin or method.
REST API keys
Pre-generated keys can be used to authenticate use of the REST API endpoints. New keys can be generated either through the WordPress admin interface or they can be auto-generated through an endpoint.
Generating API keys in the WordPress admin interface
To create or manage keys for a specific WordPress user, go to WooCommerce > Advanced > REST API.
Click the "Add Key" button. In the next screen, add a description and select the WordPress user you would like to generate the key for. Use of the REST API with the generated keys will conform to that user's WordPress roles and capabilities.
Choose the level of access for this REST API key, which can be Read access, Write access or Read/Write access. Then click the "Generate API Key" button and WooCommerce will generate REST API keys for the selected user.
Now that keys have been generated, you should see two new keys, a QRCode, and a Revoke API Key button. These two keys are your Consumer Key and Consumer Secret.
If the WordPress user associated with an API key is deleted, the API key will cease to function. API keys are not transferred to other users.
Auto generating API keys using our Application Authentication Endpoint
This endpoint can be used by any APP to allow users to generate API keys for your APP. This makes integration with WooCommerce API easier because the user only needs to grant access to your APP via a URL. After being redirected back to your APP, the API keys will be sent back in a separate POST request.
The following image illustrates how this works:
URL parameters
| Parameter | Type | Description |
|---|---|---|
app_name |
string | Your APP name mandatory |
scope |
string | Level of access. Available: read, write and read_write mandatory |
user_id |
string | User ID in your APP. For your internal reference, used when the user is redirected back to your APP. NOT THE USER ID IN WOOCOMMERCE mandatory |
return_url |
string | URL the user will be redirected to after authentication mandatory |
callback_url |
string | URL that will receive the generated API key. Note: this URL should be over HTTPS mandatory |
Creating an authentication endpoint URL
You must use the /wc-auth/v1/authorize endpoint and pass the above parameters as a query string.
Example of how to build an authentication URL:
# Bash example
STORE_URL='http://example.com'
ENDPOINT='/wc-auth/v1/authorize'
PARAMS="app_name=My App Name&scope=read_write&user_id=123&return_url=http://app.com/return-page&callback_url=https://app.com/callback-endpoint"
QUERY_STRING="$(perl -MURI::Escape -e 'print uri_escape($ARGV[0]);' "$PARAMS")"
QUERY_STRING=$(echo $QUERY_STRING | sed -e "s/%20/\+/g" -e "s/%3D/\=/g" -e "s/%26/\&/g")
echo "$STORE_URL$ENDPOINT?$QUERY_STRING"
const querystring = require('querystring');
const store_url = 'http://example.com';
const endpoint = '/wc-auth/v1/authorize';
const params = {
app_name: 'My App Name',
scope: 'read_write',
user_id: 123,
return_url: 'http://app.com/return-page',
callback_url: 'https://app.com/callback-endpoint'
};
const query_string = querystring.stringify(params).replace(/%20/g, '+');
console.log(store_url + endpoint + '?' + query_string);
<?php
$store_url = 'http://example.com';
$endpoint = '/wc-auth/v1/authorize';
$params = [
'app_name' => 'My App Name',
'scope' => 'write',
'user_id' => 123,
'return_url' => 'http://app.com',
'callback_url' => 'https://app.com'
];
$query_string = http_build_query( $params );
echo $store_url . $endpoint . '?' . $query_string;
?>
from urllib.parse import urlencode
store_url = 'http://example.com'
endpoint = '/wc-auth/v1/authorize'
params = {
"app_name": "My App Name",
"scope": "read_write",
"user_id": 123,
"return_url": "http://app.com/return-page",
"callback_url": "https://app.com/callback-endpoint"
}
query_string = urlencode(params)
print("%s%s?%s" % (store_url, endpoint, query_string))
require "uri"
store_url = 'http://example.com'
endpoint = '/wc-auth/v1/authorize'
params = {
app_name: "My App Name",
scope: "read_write",
user_id: 123,
return_url: "http://app.com/return-page",
callback_url: "https://app.com/callback-endpoint"
}
query_string = URI.encode_www_form(params)
puts "#{store_url}#{endpoint}?#{query_string}"
Example of JSON posted with the API Keys
{
"key_id": 1,
"user_id": 123,
"consumer_key": "ck_xxxxxxxxxxxxxxxx",
"consumer_secret": "cs_xxxxxxxxxxxxxxxx",
"key_permissions": "read_write"
}
Example of the screen that the user will see:
Notes
- While redirecting the user using
return_url, you are also sentsuccessanduser_idparameters as query strings. successsends0if the user denied, or1if authenticated successfully.- Use
user_idto identify the user when redirected back to the (return_url) and also remember to save the API Keys when yourcallback_urlis posted to after auth. - The auth endpoint will send the API Keys in JSON format to the
callback_url, so it's important to remember that some languages such as PHP will not display it inside the$_POSTglobal variable, in PHP you can access it using$HTTP_RAW_POST_DATA(for old PHP versions) orfile_get_contents('php://input');. - The URL generated must have all query string values encoded.
Authentication over HTTPS
You may use HTTP Basic Auth by providing the REST API Consumer Key as the username and the REST API Consumer Secret as the password.
HTTP Basic Auth example
curl https://www.example.com/wp-json/wc/v3/atum/purchase-orders \
-u consumer_key:consumer_secret
const WooCommerceRestApi = require("@woocommerce/woocommerce-rest-api").default;
// import WooCommerceRestApi from "@woocommerce/woocommerce-rest-api"; // Supports ESM
const WooCommerce = new WooCommerceRestApi({
url: 'https://example.com',
consumerKey: 'consumer_key',
consumerSecret: 'consumer_secret',
version: 'wc/v3'
});
<?php
require __DIR__ . '/vendor/autoload.php';
use Automattic\WooCommerce\Client;
$woocommerce = new Client(
'https://example.com',
'consumer_key',
'consumer_secret',
[
'wp_api' => true,
'version' => 'wc/v3'
]
);
?>
from woocommerce import API
wcapi = API(
url="https://example.com",
consumer_key="consumer_key",
consumer_secret="consumer_secret",
wp_api=True,
version="wc/v3"
)
require "woocommerce_api"
woocommerce = WooCommerce::API.new(
"https://example.com",
"consumer_key",
"consumer_secret",
{
wp_json: true,
version: "wc/v3"
}
)
Occasionally some servers may not parse the Authorization header correctly (if you see a "Consumer key is missing" error when authenticating over SSL, you have a server issue). In this case, you may provide the consumer key/secret as query string parameters instead.
Example for servers that not properly parse the Authorization header:
curl https://www.example.com/wp-json/wc/v3/orders?consumer_key=123&consumer_secret=abc
const WooCommerceRestApi = require("@woocommerce/woocommerce-rest-api").default;
// import WooCommerceRestApi from "@woocommerce/woocommerce-rest-api"; // Supports ESM
const WooCommerce = new WooCommerceRestApi({
url: 'https://example.com',
consumerKey: 'consumer_key',
consumerSecret: 'consumer_secret',
version: 'wc/v3',
queryStringAuth: true // Force Basic Authentication as query string true and using under HTTPS
});
<?php
require __DIR__ . '/vendor/autoload.php';
use Automattic\WooCommerce\Client;
$woocommerce = new Client(
'https://example.com',
'consumer_key',
'consumer_secret',
[
'wp_api' => true,
'version' => 'wc/v3',
'query_string_auth' => true // Force Basic Authentication as query string true and using under HTTPS
]
);
?>
from woocommerce import API
wcapi = API(
url="https://example.com",
consumer_key="consumer_key",
consumer_secret="consumer_secret",
wp_api=True,
version="wc/v3",
query_string_auth=True // Force Basic Authentication as query string true and using under HTTPS
)
require "woocommerce_api"
woocommerce = WooCommerce::API.new(
"https://example.com",
"consumer_key",
"consumer_secret",
{
wp_json: true,
version: "wc/v3",
query_string_auth: true // Force Basic Authentication as query string true and using under HTTPS
}
)
Authentication over HTTP
You must use OAuth 1.0a "one-legged" authentication to ensure REST API credentials cannot be intercepted by an attacker. Typically you will use any standard OAuth 1.0a library in the language of your choice to handle the authentication, or generate the necessary parameters by following the following instructions.
Creating a signature
Collect the request method and URL
First you need to determine the HTTP method you will be using for the request, and the URL of the request.
The HTTP method will be GET in our case.
The Request URL will be the endpoint you are posting to, e.g. http://www.example.com/wp-json/wc/v3/atum/purchase-orders.
Collect parameters
Collect and normalize your parameters. This includes all oauth_* parameters except for the oauth_signature itself.
These values need to be encoded into a single string which will be used later on. The process to build the string is very specific:
- Percent encode every key and value that will be signed.
- Sort the list of parameters alphabetically by encoded key.
- For each key/value pair:
- Append the encoded key to the output string.
- Append the
=character to the output string. - Append the encoded value to the output string.
- If there are more key/value pairs remaining, append a
&character to the output string.
When percent encoding in PHP for example, you would use rawurlencode().
When sorting parameters in PHP for example, you would use uksort( $params, 'strcmp' ).
Parameters example:
oauth_consumer_key=abc123&oauth_signature_method=HMAC-SHA1
Create the signature base string
The above values collected so far must be joined to make a single string, from which the signature will be generated. This is called the signature base string in the OAuth specification.
To encode the HTTP method, request URL, and parameter string into a single string:
- Set the output string equal to the uppercase HTTP Method.
- Append the
&character to the output string. - Percent encode the URL and append it to the output string.
- Append the
&character to the output string. - Percent encode the parameter string and append it to the output string.
Example signature base string:
GET&http%3A%2F%2Fwww.example.com%2Fwp-json%2Fwc%2Fv3%2Forders&oauth_consumer_key%3Dabc123%26oauth_signature_method%3DHMAC-SHA1
Generate the signature
Generate the signature using the signature base string and your consumer secret key with a & character with the HMAC-SHA1 hashing algorithm.
In PHP you can use the hash_hmac function.
HMAC-SHA1 or HMAC-SHA256 are the only accepted hash algorithms.
If you are having trouble generating a correct signature, you'll want to review the string you are signing for encoding errors. The authentication source can also be helpful in understanding how to properly generate the signature.
OAuth tips
- The OAuth parameters may be added as query string parameters or included in the Authorization header.
- Note there is no reliable cross-platform way to get the raw request headers in WordPress, so query string should be more reliable in some cases.
- The required parameters are:
oauth_consumer_key,oauth_timestamp,oauth_nonce,oauth_signature, andoauth_signature_method.oauth_versionis not required and should be omitted. - The OAuth nonce can be any randomly generated 32 character (recommended) string that is unique to the consumer key. Read more suggestions on generating nonces on the Twitter REST API forums.
- The OAuth timestamp should be the unix timestamp at the time of the request. The REST API will deny any requests that include a timestamp outside of a 15 minute window to prevent replay attacks.
- You must use the store URL provided by the index when forming the base string used for the signature, as this is what the server will use. (e.g. if the store URL includes a
wwwsub-domain, you should use it for requests) - You may test your generated signature using LinkedIn's OAuth test console -- leave the member token/secret blank.
- Twitter has great instructions on generating signatures with OAuth 1.0a, but remember tokens are not used with this implementation.
- Note that the request body is not signed as per the OAuth spec, see Google's OAuth 1.0 extension for details on why.
- If including parameters in your request, it saves a lot of trouble if you can order your items alphabetically.
- Authorization header is supported starting WooCommerce 3.0.
Index
By default, the API provides information about all available endpoints on the site. Authentication is not required to access the API index.
HTTP request
GET
/wp-json/wc/v3
curl https://example.com/wp-json/wc/v3
WooCommerce.get("")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('')); ?>
print(wcapi.get("").json())
woocommerce.get("").parsed_response
JSON response example:
{
"namespace": "wc/v3",
"routes": {
"/wc/v3": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"namespace": {
"required": false,
"default": "wc/v3"
},
"context": {
"required": false,
"default": "view"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3"
}
},
"/wc/v3/coupons": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
},
"page": {
"required": false,
"default": 1,
"description": "Current page of the collection.",
"type": "integer"
},
"per_page": {
"required": false,
"default": 10,
"description": "Maximum number of items to be returned in result set.",
"type": "integer"
},
"search": {
"required": false,
"description": "Limit results to those matching a string.",
"type": "string"
},
"after": {
"required": false,
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string"
},
"before": {
"required": false,
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string"
},
"exclude": {
"required": false,
"default": [],
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"include": {
"required": false,
"default": [],
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
}
},
"offset": {
"required": false,
"description": "Offset the result set by a specific number of items.",
"type": "integer"
},
"order": {
"required": false,
"default": "desc",
"enum": [
"asc",
"desc"
],
"description": "Order sort attribute ascending or descending.",
"type": "string"
},
"orderby": {
"required": false,
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug"
],
"description": "Sort collection by object attribute.",
"type": "string"
},
"code": {
"required": false,
"description": "Limit result set to resources with a specific code.",
"type": "string"
}
}
},
{
"methods": [
"POST"
],
"args": {
"code": {
"required": true,
"description": "Coupon code.",
"type": "string"
},
"amount": {
"required": false,
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
"type": "string"
},
"discount_type": {
"required": false,
"default": "fixed_cart",
"enum": [
"percent",
"fixed_cart",
"fixed_product"
],
"description": "Determines the type of discount that will be applied.",
"type": "string"
},
"description": {
"required": false,
"description": "Coupon description.",
"type": "string"
},
"date_expires": {
"required": false,
"description": "The date the coupon expires, in the site's timezone.",
"type": "string"
},
"date_expires_gmt": {
"required": false,
"description": "The date the coupon expires, as GMT.",
"type": "string"
},
"individual_use": {
"required": false,
"default": false,
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
"type": "boolean"
},
"product_ids": {
"required": false,
"description": "List of product IDs the coupon can be used on.",
"type": "array",
"items": {
"type": "integer"
}
},
"excluded_product_ids": {
"required": false,
"description": "List of product IDs the coupon cannot be used on.",
"type": "array",
"items": {
"type": "integer"
}
},
"usage_limit": {
"required": false,
"description": "How many times the coupon can be used in total.",
"type": "integer"
},
"usage_limit_per_user": {
"required": false,
"description": "How many times the coupon can be used per customer.",
"type": "integer"
},
"limit_usage_to_x_items": {
"required": false,
"description": "Max number of items in the basket the coupon can be applied to.",
"type": "integer"
},
"free_shipping": {
"required": false,
"default": false,
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
"type": "boolean"
},
"product_categories": {
"required": false,
"description": "List of category IDs the coupon applies to.",
"type": "array",
"items": {
"type": "integer"
}
},
"excluded_product_categories": {
"required": false,
"description": "List of category IDs the coupon does not apply to.",
"type": "array",
"items": {
"type": "integer"
}
},
"exclude_sale_items": {
"required": false,
"default": false,
"description": "If true, this coupon will not be applied to items that have sale prices.",
"type": "boolean"
},
"minimum_amount": {
"required": false,
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
"type": "string"
},
"maximum_amount": {
"required": false,
"description": "Maximum order amount allowed when using the coupon.",
"type": "string"
},
"email_restrictions": {
"required": false,
"description": "List of email addresses that can use this coupon.",
"type": "array",
"items": {
"type": "string"
}
},
"meta_data": {
"required": false,
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/coupons"
}
},
"/wc/v3/coupons/(?P<id>[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"code": {
"required": false,
"description": "Coupon code.",
"type": "string"
},
"amount": {
"required": false,
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
"type": "string"
},
"discount_type": {
"required": false,
"enum": [
"percent",
"fixed_cart",
"fixed_product"
],
"description": "Determines the type of discount that will be applied.",
"type": "string"
},
"description": {
"required": false,
"description": "Coupon description.",
"type": "string"
},
"date_expires": {
"required": false,
"description": "The date the coupon expires, in the site's timezone.",
"type": "string"
},
"date_expires_gmt": {
"required": false,
"description": "The date the coupon expires, as GMT.",
"type": "string"
},
"individual_use": {
"required": false,
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
"type": "boolean"
},
"product_ids": {
"required": false,
"description": "List of product IDs the coupon can be used on.",
"type": "array",
"items": {
"type": "integer"
}
},
"excluded_product_ids": {
"required": false,
"description": "List of product IDs the coupon cannot be used on.",
"type": "array",
"items": {
"type": "integer"
}
},
"usage_limit": {
"required": false,
"description": "How many times the coupon can be used in total.",
"type": "integer"
},
"usage_limit_per_user": {
"required": false,
"description": "How many times the coupon can be used per customer.",
"type": "integer"
},
"limit_usage_to_x_items": {
"required": false,
"description": "Max number of items in the basket the coupon can be applied to.",
"type": "integer"
},
"free_shipping": {
"required": false,
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
"type": "boolean"
},
"product_categories": {
"required": false,
"description": "List of category IDs the coupon applies to.",
"type": "array",
"items": {
"type": "integer"
}
},
"excluded_product_categories": {
"required": false,
"description": "List of category IDs the coupon does not apply to.",
"type": "array",
"items": {
"type": "integer"
}
},
"exclude_sale_items": {
"required": false,
"description": "If true, this coupon will not be applied to items that have sale prices.",
"type": "boolean"
},
"minimum_amount": {
"required": false,
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
"type": "string"
},
"maximum_amount": {
"required": false,
"description": "Maximum order amount allowed when using the coupon.",
"type": "string"
},
"email_restrictions": {
"required": false,
"description": "List of email addresses that can use this coupon.",
"type": "array",
"items": {
"type": "string"
}
},
"meta_data": {
"required": false,
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"force": {
"required": false,
"default": false,
"description": "Whether to bypass bin and force deletion.",
"type": "boolean"
}
}
}
]
},
"/wc/v3/coupons/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"code": {
"required": false,
"description": "Coupon code.",
"type": "string"
},
"amount": {
"required": false,
"description": "The amount of discount. Should always be numeric, even if setting a percentage.",
"type": "string"
},
"discount_type": {
"required": false,
"enum": [
"percent",
"fixed_cart",
"fixed_product"
],
"description": "Determines the type of discount that will be applied.",
"type": "string"
},
"description": {
"required": false,
"description": "Coupon description.",
"type": "string"
},
"date_expires": {
"required": false,
"description": "The date the coupon expires, in the site's timezone.",
"type": "string"
},
"date_expires_gmt": {
"required": false,
"description": "The date the coupon expires, as GMT.",
"type": "string"
},
"individual_use": {
"required": false,
"description": "If true, the coupon can only be used individually. Other applied coupons will be removed from the basket.",
"type": "boolean"
},
"product_ids": {
"required": false,
"description": "List of product IDs the coupon can be used on.",
"type": "array",
"items": {
"type": "integer"
}
},
"excluded_product_ids": {
"required": false,
"description": "List of product IDs the coupon cannot be used on.",
"type": "array",
"items": {
"type": "integer"
}
},
"usage_limit": {
"required": false,
"description": "How many times the coupon can be used in total.",
"type": "integer"
},
"usage_limit_per_user": {
"required": false,
"description": "How many times the coupon can be used per customer.",
"type": "integer"
},
"limit_usage_to_x_items": {
"required": false,
"description": "Max number of items in the basket the coupon can be applied to.",
"type": "integer"
},
"free_shipping": {
"required": false,
"description": "If true and if the free shipping method requires a coupon, this coupon will enable free shipping.",
"type": "boolean"
},
"product_categories": {
"required": false,
"description": "List of category IDs the coupon applies to.",
"type": "array",
"items": {
"type": "integer"
}
},
"excluded_product_categories": {
"required": false,
"description": "List of category IDs the coupon does not apply to.",
"type": "array",
"items": {
"type": "integer"
}
},
"exclude_sale_items": {
"required": false,
"description": "If true, this coupon will not be applied to items that have sale prices.",
"type": "boolean"
},
"minimum_amount": {
"required": false,
"description": "Minimum order amount that needs to be in the basket before coupon applies.",
"type": "string"
},
"maximum_amount": {
"required": false,
"description": "Maximum order amount allowed when using the coupon.",
"type": "string"
},
"email_restrictions": {
"required": false,
"description": "List of email addresses that can use this coupon.",
"type": "array",
"items": {
"type": "string"
}
},
"meta_data": {
"required": false,
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/coupons/batch"
}
},
"/wc/v3/customers/(?P<customer_id>[\\d]+)/downloads": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"customer_id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
}
]
},
"/wc/v3/customers": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
},
"page": {
"required": false,
"default": 1,
"description": "Current page of the collection.",
"type": "integer"
},
"per_page": {
"required": false,
"default": 10,
"description": "Maximum number of items to be returned in result set.",
"type": "integer"
},
"search": {
"required": false,
"description": "Limit results to those matching a string.",
"type": "string"
},
"exclude": {
"required": false,
"default": [],
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"include": {
"required": false,
"default": [],
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"offset": {
"required": false,
"description": "Offset the result set by a specific number of items.",
"type": "integer"
},
"order": {
"required": false,
"default": "asc",
"enum": [
"asc",
"desc"
],
"description": "Order sort attribute ascending or descending.",
"type": "string"
},
"orderby": {
"required": false,
"default": "name",
"enum": [
"id",
"include",
"name",
"registered_date"
],
"description": "Sort collection by object attribute.",
"type": "string"
},
"email": {
"required": false,
"description": "Limit result set to resources with a specific email.",
"type": "string"
},
"role": {
"required": false,
"default": "customer",
"enum": [
"all",
"administrator",
"editor",
"author",
"contributor",
"subscriber",
"customer",
"shop_manager",
"translator"
],
"description": "Limit result set to resources with a specific role.",
"type": "string"
}
}
},
{
"methods": [
"POST"
],
"args": {
"email": {
"required": true,
"description": "New user email address.",
"type": "string"
},
"first_name": {
"required": false,
"description": "Customer first name.",
"type": "string"
},
"last_name": {
"required": false,
"description": "Customer last name.",
"type": "string"
},
"username": {
"required": false,
"description": "New user username.",
"type": "string"
},
"password": {
"required": true,
"description": "New user password.",
"type": "string"
},
"billing": {
"required": false,
"description": "List of billing address data.",
"type": "object"
},
"shipping": {
"required": false,
"description": "List of shipping address data.",
"type": "object"
},
"meta_data": {
"required": false,
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/customers"
}
},
"/wc/v3/customers/(?P<id>[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"email": {
"required": false,
"description": "The email address for the customer.",
"type": "string"
},
"first_name": {
"required": false,
"description": "Customer first name.",
"type": "string"
},
"last_name": {
"required": false,
"description": "Customer last name.",
"type": "string"
},
"username": {
"required": false,
"description": "Customer login name.",
"type": "string"
},
"password": {
"required": false,
"description": "Customer password.",
"type": "string"
},
"billing": {
"required": false,
"description": "List of billing address data.",
"type": "object"
},
"shipping": {
"required": false,
"description": "List of shipping address data.",
"type": "object"
},
"meta_data": {
"required": false,
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"force": {
"required": false,
"default": false,
"description": "Required to be true, as resource does not support binning.",
"type": "boolean"
},
"reassign": {
"required": false,
"default": 0,
"description": "ID to reassign posts to.",
"type": "integer"
}
}
}
]
},
"/wc/v3/customers/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"email": {
"required": false,
"description": "The email address for the customer.",
"type": "string"
},
"first_name": {
"required": false,
"description": "Customer first name.",
"type": "string"
},
"last_name": {
"required": false,
"description": "Customer last name.",
"type": "string"
},
"username": {
"required": false,
"description": "Customer login name.",
"type": "string"
},
"password": {
"required": false,
"description": "Customer password.",
"type": "string"
},
"billing": {
"required": false,
"description": "List of billing address data.",
"type": "object"
},
"shipping": {
"required": false,
"description": "List of shipping address data.",
"type": "object"
},
"meta_data": {
"required": false,
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/customers/batch"
}
},
"/wc/v3/orders/(?P<order_id>[\\d]+)/notes": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"order_id": {
"required": false,
"description": "The order ID.",
"type": "integer"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
},
"type": {
"required": false,
"default": "any",
"enum": [
"any",
"customer",
"internal"
],
"description": "Limit result to customers or internal notes.",
"type": "string"
}
}
},
{
"methods": [
"POST"
],
"args": {
"order_id": {
"required": false,
"description": "The order ID.",
"type": "integer"
},
"note": {
"required": true,
"description": "Order note content.",
"type": "string"
},
"customer_note": {
"required": false,
"default": false,
"description": "If true, the note will be shown to customers and they will be notified. If false, the note will be for admin reference only.",
"type": "boolean"
},
"added_by_user": {
"required": false,
"default": false,
"description": "If true, this note will be attributed to the current user. If false, the note will be attributed to the system.",
"type": "boolean"
}
}
}
]
},
"/wc/v3/orders/(?P<order_id>[\\d]+)/notes/(?P<id>[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"order_id": {
"required": false,
"description": "The order ID.",
"type": "integer"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"order_id": {
"required": false,
"description": "The order ID.",
"type": "integer"
},
"force": {
"required": false,
"default": false,
"description": "Required to be true, as resource does not support binning.",
"type": "boolean"
}
}
}
]
},
"/wc/v3/orders/(?P<order_id>[\\d]+)/refunds": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"order_id": {
"required": false,
"description": "The order ID.",
"type": "integer"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
},
"page": {
"required": false,
"default": 1,
"description": "Current page of the collection.",
"type": "integer"
},
"per_page": {
"required": false,
"default": 10,
"description": "Maximum number of items to be returned in result set.",
"type": "integer"
},
"search": {
"required": false,
"description": "Limit results to those matching a string.",
"type": "string"
},
"after": {
"required": false,
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string"
},
"before": {
"required": false,
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string"
},
"exclude": {
"required": false,
"default": [],
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"include": {
"required": false,
"default": [],
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
}
},
"offset": {
"required": false,
"description": "Offset the result set by a specific number of items.",
"type": "integer"
},
"order": {
"required": false,
"default": "desc",
"enum": [
"asc",
"desc"
],
"description": "Order sort attribute ascending or descending.",
"type": "string"
},
"orderby": {
"required": false,
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug"
],
"description": "Sort collection by object attribute.",
"type": "string"
},
"parent": {
"required": false,
"default": [],
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"parent_exclude": {
"required": false,
"default": [],
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
}
},
"dp": {
"required": false,
"default": 2,
"description": "Number of decimal points to use in each resource.",
"type": "integer"
}
}
},
{
"methods": [
"POST"
],
"args": {
"order_id": {
"required": false,
"description": "The order ID.",
"type": "integer"
},
"amount": {
"required": false,
"description": "Refund amount.",
"type": "string"
},
"reason": {
"required": false,
"description": "Reason for refund.",
"type": "string"
},
"refunded_by": {
"required": false,
"description": "User ID of user who created the refund.",
"type": "integer"
},
"meta_data": {
"required": false,
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
},
"api_refund": {
"required": false,
"default": true,
"description": "When true, the payment gateway API is used to generate the refund.",
"type": "boolean"
}
}
}
]
},
"/wc/v3/orders/(?P<order_id>[\\d]+)/refunds/(?P<id>[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"order_id": {
"required": false,
"description": "The order ID.",
"type": "integer"
},
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"order_id": {
"required": false,
"description": "The order ID.",
"type": "integer"
},
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"force": {
"required": false,
"default": true,
"description": "Required to be true, as resource does not support binning.",
"type": "boolean"
}
}
}
]
},
"/wc/v3/orders": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
},
"page": {
"required": false,
"default": 1,
"description": "Current page of the collection.",
"type": "integer"
},
"per_page": {
"required": false,
"default": 10,
"description": "Maximum number of items to be returned in result set.",
"type": "integer"
},
"search": {
"required": false,
"description": "Limit results to those matching a string.",
"type": "string"
},
"after": {
"required": false,
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string"
},
"before": {
"required": false,
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string"
},
"exclude": {
"required": false,
"default": [],
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"include": {
"required": false,
"default": [],
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
}
},
"offset": {
"required": false,
"description": "Offset the result set by a specific number of items.",
"type": "integer"
},
"order": {
"required": false,
"default": "desc",
"enum": [
"asc",
"desc"
],
"description": "Order sort attribute ascending or descending.",
"type": "string"
},
"orderby": {
"required": false,
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug"
],
"description": "Sort collection by object attribute.",
"type": "string"
},
"parent": {
"required": false,
"default": [],
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"parent_exclude": {
"required": false,
"default": [],
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
}
},
"status": {
"required": false,
"default": "any",
"description": "Limit result set to orders which have specific statuses.",
"type": "array",
"items": {
"type": "string",
"enum": [
"any",
"trash",
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed"
]
}
},
"customer": {
"required": false,
"description": "Limit result set to orders assigned a specific customer.",
"type": "integer"
},
"product": {
"required": false,
"description": "Limit result set to orders assigned a specific product.",
"type": "integer"
},
"dp": {
"required": false,
"default": 2,
"description": "Number of decimal points to use in each resource.",
"type": "integer"
}
}
},
{
"methods": [
"POST"
],
"args": {
"parent_id": {
"required": false,
"description": "Parent order ID.",
"type": "integer"
},
"status": {
"required": false,
"default": "pending",
"enum": [
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed"
],
"description": "Order status.",
"type": "string"
},
"currency": {
"required": false,
"default": "EUR",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYR",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"IRT",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PRB",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
],
"description": "Currency the order was created with, in ISO format.",
"type": "string"
},
"customer_id": {
"required": false,
"default": 0,
"description": "User ID who owns the order. 0 for guests.",
"type": "integer"
},
"customer_note": {
"required": false,
"description": "Note left by customer during checkout.",
"type": "string"
},
"billing": {
"required": false,
"description": "Billing address.",
"type": "object"
},
"shipping": {
"required": false,
"description": "Shipping address.",
"type": "object"
},
"payment_method": {
"required": false,
"description": "Payment method ID.",
"type": "string"
},
"payment_method_title": {
"required": false,
"description": "Payment method title.",
"type": "string"
},
"transaction_id": {
"required": false,
"description": "Unique transaction ID.",
"type": "string"
},
"meta_data": {
"required": false,
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
},
"line_items": {
"required": false,
"description": "Line items data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Product name.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"product_id": {
"description": "Product ID.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"variation_id": {
"description": "Variation ID, if applicable.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity": {
"description": "Quantity ordered.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of product.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Line subtotal (before discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal_tax": {
"description": "Line subtotal tax (before discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
},
"sku": {
"description": "Product SKU.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"price": {
"description": "Product price.",
"type": "number",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"shipping_lines": {
"required": false,
"description": "Shipping lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"method_title": {
"description": "Shipping method name.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"method_id": {
"description": "Shipping method ID.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"instance_id": {
"description": "Shipping instance ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
}
},
"fee_lines": {
"required": false,
"description": "Fee lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Fee name.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of fee.",
"type": "string",
"context": [
"view",
"edit"
]
},
"tax_status": {
"description": "Tax status of fee.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"taxable",
"none"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
}
},
"coupon_lines": {
"required": false,
"description": "Coupons line data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"code": {
"description": "Coupon code.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"discount": {
"description": "Discount total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"discount_tax": {
"description": "Discount total tax.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
}
},
"set_paid": {
"required": false,
"default": false,
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
"type": "boolean"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/orders"
}
},
"/wc/v3/orders/(?P<id>[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"parent_id": {
"required": false,
"description": "Parent order ID.",
"type": "integer"
},
"status": {
"required": false,
"enum": [
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed"
],
"description": "Order status.",
"type": "string"
},
"currency": {
"required": false,
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYR",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"IRT",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PRB",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
],
"description": "Currency the order was created with, in ISO format.",
"type": "string"
},
"customer_id": {
"required": false,
"description": "User ID who owns the order. 0 for guests.",
"type": "integer"
},
"customer_note": {
"required": false,
"description": "Note left by customer during checkout.",
"type": "string"
},
"billing": {
"required": false,
"description": "Billing address.",
"type": "object"
},
"shipping": {
"required": false,
"description": "Shipping address.",
"type": "object"
},
"payment_method": {
"required": false,
"description": "Payment method ID.",
"type": "string"
},
"payment_method_title": {
"required": false,
"description": "Payment method title.",
"type": "string"
},
"transaction_id": {
"required": false,
"description": "Unique transaction ID.",
"type": "string"
},
"meta_data": {
"required": false,
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
},
"line_items": {
"required": false,
"description": "Line items data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Product name.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"product_id": {
"description": "Product ID.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"variation_id": {
"description": "Variation ID, if applicable.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity": {
"description": "Quantity ordered.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of product.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Line subtotal (before discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal_tax": {
"description": "Line subtotal tax (before discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
},
"sku": {
"description": "Product SKU.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"price": {
"description": "Product price.",
"type": "number",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"shipping_lines": {
"required": false,
"description": "Shipping lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"method_title": {
"description": "Shipping method name.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"method_id": {
"description": "Shipping method ID.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"instance_id": {
"description": "Shipping instance ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
}
},
"fee_lines": {
"required": false,
"description": "Fee lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Fee name.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of fee.",
"type": "string",
"context": [
"view",
"edit"
]
},
"tax_status": {
"description": "Tax status of fee.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"taxable",
"none"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
}
},
"coupon_lines": {
"required": false,
"description": "Coupons line data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"code": {
"description": "Coupon code.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"discount": {
"description": "Discount total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"discount_tax": {
"description": "Discount total tax.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
}
},
"set_paid": {
"required": false,
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
"type": "boolean"
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"force": {
"required": false,
"default": false,
"description": "Whether to bypass bin and force deletion.",
"type": "boolean"
}
}
}
]
},
"/wc/v3/orders/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"parent_id": {
"required": false,
"description": "Parent order ID.",
"type": "integer"
},
"status": {
"required": false,
"enum": [
"pending",
"processing",
"on-hold",
"completed",
"cancelled",
"refunded",
"failed"
],
"description": "Order status.",
"type": "string"
},
"currency": {
"required": false,
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYR",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"IRT",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PRB",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
],
"description": "Currency the order was created with, in ISO format.",
"type": "string"
},
"customer_id": {
"required": false,
"description": "User ID who owns the order. 0 for guests.",
"type": "integer"
},
"customer_note": {
"required": false,
"description": "Note left by customer during checkout.",
"type": "string"
},
"billing": {
"required": false,
"description": "Billing address.",
"type": "object"
},
"shipping": {
"required": false,
"description": "Shipping address.",
"type": "object"
},
"payment_method": {
"required": false,
"description": "Payment method ID.",
"type": "string"
},
"payment_method_title": {
"required": false,
"description": "Payment method title.",
"type": "string"
},
"transaction_id": {
"required": false,
"description": "Unique transaction ID.",
"type": "string"
},
"meta_data": {
"required": false,
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
},
"line_items": {
"required": false,
"description": "Line items data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Product name.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"product_id": {
"description": "Product ID.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"variation_id": {
"description": "Variation ID, if applicable.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity": {
"description": "Quantity ordered.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of product.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Line subtotal (before discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal_tax": {
"description": "Line subtotal tax (before discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
},
"sku": {
"description": "Product SKU.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"price": {
"description": "Product price.",
"type": "number",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"shipping_lines": {
"required": false,
"description": "Shipping lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"method_title": {
"description": "Shipping method name.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"method_id": {
"description": "Shipping method ID.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"instance_id": {
"description": "Shipping instance ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
}
},
"fee_lines": {
"required": false,
"description": "Fee lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Fee name.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of fee.",
"type": "string",
"context": [
"view",
"edit"
]
},
"tax_status": {
"description": "Tax status of fee.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"taxable",
"none"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
}
},
"coupon_lines": {
"required": false,
"description": "Coupons line data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"code": {
"description": "Coupon code.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"discount": {
"description": "Discount total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"discount_tax": {
"description": "Discount total tax.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
}
},
"set_paid": {
"required": false,
"description": "Define if the order is paid. It will set the status to processing and reduce stock items.",
"type": "boolean"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/orders/batch"
}
},
"/wc/v3/products/attributes/(?P<attribute_id>[\\d]+)/terms": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"attribute_id": {
"required": false,
"description": "Unique identifier for the attribute of the terms.",
"type": "integer"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
},
"page": {
"required": false,
"default": 1,
"description": "Current page of the collection.",
"type": "integer"
},
"per_page": {
"required": false,
"default": 10,
"description": "Maximum number of items to be returned in result set.",
"type": "integer"
},
"search": {
"required": false,
"description": "Limit results to those matching a string.",
"type": "string"
},
"exclude": {
"required": false,
"default": [],
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"include": {
"required": false,
"default": [],
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
}
},
"order": {
"required": false,
"default": "asc",
"enum": [
"asc",
"desc"
],
"description": "Order sort attribute ascending or descending.",
"type": "string"
},
"orderby": {
"required": false,
"default": "name",
"enum": [
"id",
"include",
"name",
"slug",
"term_group",
"description",
"count"
],
"description": "Sort collection by resource attribute.",
"type": "string"
},
"hide_empty": {
"required": false,
"default": false,
"description": "Whether to hide resources not assigned to any products.",
"type": "boolean"
},
"parent": {
"required": false,
"description": "Limit result set to resources assigned to a specific parent.",
"type": "integer"
},
"product": {
"required": false,
"description": "Limit result set to resources assigned to a specific product.",
"type": "integer"
},
"slug": {
"required": false,
"description": "Limit result set to resources with a specific slug.",
"type": "string"
}
}
},
{
"methods": [
"POST"
],
"args": {
"attribute_id": {
"required": false,
"description": "Unique identifier for the attribute of the terms.",
"type": "integer"
},
"name": {
"required": true,
"description": "Name for the resource.",
"type": "string"
},
"slug": {
"required": false,
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string"
},
"description": {
"required": false,
"description": "HTML description of the resource.",
"type": "string"
},
"menu_order": {
"required": false,
"description": "Menu order, used to custom sort the resource.",
"type": "integer"
}
}
}
]
},
"/wc/v3/products/attributes/(?P<attribute_id>[\\d]+)/terms/(?P<id>[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"attribute_id": {
"required": false,
"description": "Unique identifier for the attribute of the terms.",
"type": "integer"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"attribute_id": {
"required": false,
"description": "Unique identifier for the attribute of the terms.",
"type": "integer"
},
"name": {
"required": false,
"description": "Term name.",
"type": "string"
},
"slug": {
"required": false,
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string"
},
"description": {
"required": false,
"description": "HTML description of the resource.",
"type": "string"
},
"menu_order": {
"required": false,
"description": "Menu order, used to custom sort the resource.",
"type": "integer"
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"attribute_id": {
"required": false,
"description": "Unique identifier for the attribute of the terms.",
"type": "integer"
},
"force": {
"required": false,
"default": false,
"description": "Required to be true, as resource does not support binning.",
"type": "boolean"
}
}
}
]
},
"/wc/v3/products/attributes/(?P<attribute_id>[\\d]+)/terms/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"attribute_id": {
"required": false,
"description": "Unique identifier for the attribute of the terms.",
"type": "integer"
},
"name": {
"required": false,
"description": "Term name.",
"type": "string"
},
"slug": {
"required": false,
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string"
},
"description": {
"required": false,
"description": "HTML description of the resource.",
"type": "string"
},
"menu_order": {
"required": false,
"description": "Menu order, used to custom sort the resource.",
"type": "integer"
}
}
}
]
},
"/wc/v3/products/attributes": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"required": true,
"description": "Name for the resource.",
"type": "string"
},
"slug": {
"required": false,
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string"
},
"type": {
"required": false,
"default": "select",
"enum": [
"select"
],
"description": "Type of attribute.",
"type": "string"
},
"order_by": {
"required": false,
"default": "menu_order",
"enum": [
"menu_order",
"name",
"name_num",
"id"
],
"description": "Default sort order.",
"type": "string"
},
"has_archives": {
"required": false,
"default": false,
"description": "Enable/Disable attribute archives.",
"type": "boolean"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/products/attributes"
}
},
"/wc/v3/products/attributes/(?P<id>[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"name": {
"required": false,
"description": "Attribute name.",
"type": "string"
},
"slug": {
"required": false,
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string"
},
"type": {
"required": false,
"enum": [
"select"
],
"description": "Type of attribute.",
"type": "string"
},
"order_by": {
"required": false,
"enum": [
"menu_order",
"name",
"name_num",
"id"
],
"description": "Default sort order.",
"type": "string"
},
"has_archives": {
"required": false,
"description": "Enable/Disable attribute archives.",
"type": "boolean"
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"force": {
"required": false,
"default": true,
"description": "Required to be true, as resource does not support binning.",
"type": "boolean"
}
}
}
]
},
"/wc/v3/products/attributes/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"required": false,
"description": "Attribute name.",
"type": "string"
},
"slug": {
"required": false,
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string"
},
"type": {
"required": false,
"enum": [
"select"
],
"description": "Type of attribute.",
"type": "string"
},
"order_by": {
"required": false,
"enum": [
"menu_order",
"name",
"name_num",
"id"
],
"description": "Default sort order.",
"type": "string"
},
"has_archives": {
"required": false,
"description": "Enable/Disable attribute archives.",
"type": "boolean"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/products/attributes/batch"
}
},
"/wc/v3/products/categories": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
},
"page": {
"required": false,
"default": 1,
"description": "Current page of the collection.",
"type": "integer"
},
"per_page": {
"required": false,
"default": 10,
"description": "Maximum number of items to be returned in result set.",
"type": "integer"
},
"search": {
"required": false,
"description": "Limit results to those matching a string.",
"type": "string"
},
"exclude": {
"required": false,
"default": [],
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"include": {
"required": false,
"default": [],
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
}
},
"order": {
"required": false,
"default": "asc",
"enum": [
"asc",
"desc"
],
"description": "Order sort attribute ascending or descending.",
"type": "string"
},
"orderby": {
"required": false,
"default": "name",
"enum": [
"id",
"include",
"name",
"slug",
"term_group",
"description",
"count"
],
"description": "Sort collection by resource attribute.",
"type": "string"
},
"hide_empty": {
"required": false,
"default": false,
"description": "Whether to hide resources not assigned to any products.",
"type": "boolean"
},
"parent": {
"required": false,
"description": "Limit result set to resources assigned to a specific parent.",
"type": "integer"
},
"product": {
"required": false,
"description": "Limit result set to resources assigned to a specific product.",
"type": "integer"
},
"slug": {
"required": false,
"description": "Limit result set to resources with a specific slug.",
"type": "string"
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"required": true,
"description": "Name for the resource.",
"type": "string"
},
"slug": {
"required": false,
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string"
},
"parent": {
"required": false,
"description": "The ID for the parent of the resource.",
"type": "integer"
},
"description": {
"required": false,
"description": "HTML description of the resource.",
"type": "string"
},
"display": {
"required": false,
"default": "default",
"enum": [
"default",
"products",
"subcategories",
"both"
],
"description": "Category archive display type.",
"type": "string"
},
"image": {
"required": false,
"description": "Image data.",
"type": "object"
},
"menu_order": {
"required": false,
"description": "Menu order, used to custom sort the resource.",
"type": "integer"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/products/categories"
}
},
"/wc/v3/products/categories/(?P<id>[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"name": {
"required": false,
"description": "Category name.",
"type": "string"
},
"slug": {
"required": false,
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string"
},
"parent": {
"required": false,
"description": "The ID for the parent of the resource.",
"type": "integer"
},
"description": {
"required": false,
"description": "HTML description of the resource.",
"type": "string"
},
"display": {
"required": false,
"enum": [
"default",
"products",
"subcategories",
"both"
],
"description": "Category archive display type.",
"type": "string"
},
"image": {
"required": false,
"description": "Image data.",
"type": "object"
},
"menu_order": {
"required": false,
"description": "Menu order, used to custom sort the resource.",
"type": "integer"
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"force": {
"required": false,
"default": false,
"description": "Required to be true, as resource does not support binning.",
"type": "boolean"
}
}
}
]
},
"/wc/v3/products/categories/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"required": false,
"description": "Category name.",
"type": "string"
},
"slug": {
"required": false,
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string"
},
"parent": {
"required": false,
"description": "The ID for the parent of the resource.",
"type": "integer"
},
"description": {
"required": false,
"description": "HTML description of the resource.",
"type": "string"
},
"display": {
"required": false,
"enum": [
"default",
"products",
"subcategories",
"both"
],
"description": "Category archive display type.",
"type": "string"
},
"image": {
"required": false,
"description": "Image data.",
"type": "object"
},
"menu_order": {
"required": false,
"description": "Menu order, used to custom sort the resource.",
"type": "integer"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/products/categories/batch"
}
},
"/wc/v3/products/reviews": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
},
"page": {
"required": false,
"default": 1,
"description": "Current page of the collection.",
"type": "integer"
},
"per_page": {
"required": false,
"default": 10,
"description": "Maximum number of items to be returned in result set.",
"type": "integer"
},
"search": {
"required": false,
"description": "Limit results to those matching a string.",
"type": "string"
},
"after": {
"required": false,
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string"
},
"before": {
"required": false,
"description": "Limit response to reviews published before a given ISO8601 compliant date.",
"type": "string"
},
"exclude": {
"required": false,
"default": [],
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"include": {
"required": false,
"default": [],
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"offset": {
"required": false,
"description": "Offset the result set by a specific number of items.",
"type": "integer"
},
"order": {
"required": false,
"default": "desc",
"enum": [
"asc",
"desc"
],
"description": "Order sort attribute ascending or descending.",
"type": "string"
},
"orderby": {
"required": false,
"default": "date_gmt",
"enum": [
"date",
"date_gmt",
"id",
"include",
"product"
],
"description": "Sort collection by object attribute.",
"type": "string"
},
"reviewer": {
"required": false,
"description": "Limit result set to reviews assigned to specific user IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"reviewer_exclude": {
"required": false,
"description": "Ensure result set excludes reviews assigned to specific user IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"reviewer_email": {
"required": false,
"description": "Limit result set to that from a specific author email.",
"type": "string"
},
"product": {
"required": false,
"default": [],
"description": "Limit result set to reviews assigned to specific product IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"status": {
"required": false,
"default": "approved",
"enum": [
"all",
"hold",
"approved",
"spam",
"trash"
],
"description": "Limit result set to reviews assigned a specific status.",
"type": "string"
}
}
},
{
"methods": [
"POST"
],
"args": {
"product_id": {
"required": true,
"description": "Unique identifier for the product.",
"type": "integer"
},
"status": {
"required": false,
"default": "approved",
"enum": [
"approved",
"hold",
"spam",
"unspam",
"trash",
"untrash"
],
"description": "Status of the review.",
"type": "string"
},
"reviewer": {
"required": true,
"description": "Name of the reviewer.",
"type": "string"
},
"reviewer_email": {
"required": true,
"description": "Email of the reviewer.",
"type": "string"
},
"review": {
"required": true,
"description": "Review content.",
"type": "string"
},
"rating": {
"required": false,
"description": "Review rating (0 to 5).",
"type": "integer"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/products/reviews"
}
},
"/wc/v3/products/reviews/(?P<id>[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"product_id": {
"required": false,
"description": "Unique identifier for the product that the review belongs to.",
"type": "integer"
},
"status": {
"required": false,
"enum": [
"approved",
"hold",
"spam",
"unspam",
"trash",
"untrash"
],
"description": "Status of the review.",
"type": "string"
},
"reviewer": {
"required": false,
"description": "Reviewer name.",
"type": "string"
},
"reviewer_email": {
"required": false,
"description": "Reviewer email.",
"type": "string"
},
"review": {
"required": false,
"description": "The content of the review.",
"type": "string"
},
"rating": {
"required": false,
"description": "Review rating (0 to 5).",
"type": "integer"
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"force": {
"required": false,
"default": false,
"description": "Whether to bypass bin and force deletion.",
"type": "boolean"
}
}
}
]
},
"/wc/v3/products/reviews/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"product_id": {
"required": false,
"description": "Unique identifier for the product that the review belongs to.",
"type": "integer"
},
"status": {
"required": false,
"enum": [
"approved",
"hold",
"spam",
"unspam",
"trash",
"untrash"
],
"description": "Status of the review.",
"type": "string"
},
"reviewer": {
"required": false,
"description": "Reviewer name.",
"type": "string"
},
"reviewer_email": {
"required": false,
"description": "Reviewer email.",
"type": "string"
},
"review": {
"required": false,
"description": "The content of the review.",
"type": "string"
},
"rating": {
"required": false,
"description": "Review rating (0 to 5).",
"type": "integer"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/products/reviews/batch"
}
},
"/wc/v3/products/shipping_classes": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
},
"page": {
"required": false,
"default": 1,
"description": "Current page of the collection.",
"type": "integer"
},
"per_page": {
"required": false,
"default": 10,
"description": "Maximum number of items to be returned in result set.",
"type": "integer"
},
"search": {
"required": false,
"description": "Limit results to those matching a string.",
"type": "string"
},
"exclude": {
"required": false,
"default": [],
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"include": {
"required": false,
"default": [],
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
}
},
"offset": {
"required": false,
"description": "Offset the result set by a specific number of items.",
"type": "integer"
},
"order": {
"required": false,
"default": "asc",
"enum": [
"asc",
"desc"
],
"description": "Order sort attribute ascending or descending.",
"type": "string"
},
"orderby": {
"required": false,
"default": "name",
"enum": [
"id",
"include",
"name",
"slug",
"term_group",
"description",
"count"
],
"description": "Sort collection by resource attribute.",
"type": "string"
},
"hide_empty": {
"required": false,
"default": false,
"description": "Whether to hide resources not assigned to any products.",
"type": "boolean"
},
"product": {
"required": false,
"description": "Limit result set to resources assigned to a specific product.",
"type": "integer"
},
"slug": {
"required": false,
"description": "Limit result set to resources with a specific slug.",
"type": "string"
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"required": true,
"description": "Name for the resource.",
"type": "string"
},
"slug": {
"required": false,
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string"
},
"description": {
"required": false,
"description": "HTML description of the resource.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/products/shipping_classes"
}
},
"/wc/v3/products/shipping_classes/(?P<id>[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"name": {
"required": false,
"description": "Shipping class name.",
"type": "string"
},
"slug": {
"required": false,
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string"
},
"description": {
"required": false,
"description": "HTML description of the resource.",
"type": "string"
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"force": {
"required": false,
"default": false,
"description": "Required to be true, as resource does not support binning.",
"type": "boolean"
}
}
}
]
},
"/wc/v3/products/shipping_classes/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"required": false,
"description": "Shipping class name.",
"type": "string"
},
"slug": {
"required": false,
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string"
},
"description": {
"required": false,
"description": "HTML description of the resource.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/products/shipping_classes/batch"
}
},
"/wc/v3/products/tags": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
},
"page": {
"required": false,
"default": 1,
"description": "Current page of the collection.",
"type": "integer"
},
"per_page": {
"required": false,
"default": 10,
"description": "Maximum number of items to be returned in result set.",
"type": "integer"
},
"search": {
"required": false,
"description": "Limit results to those matching a string.",
"type": "string"
},
"exclude": {
"required": false,
"default": [],
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"include": {
"required": false,
"default": [],
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
}
},
"offset": {
"required": false,
"description": "Offset the result set by a specific number of items.",
"type": "integer"
},
"order": {
"required": false,
"default": "asc",
"enum": [
"asc",
"desc"
],
"description": "Order sort attribute ascending or descending.",
"type": "string"
},
"orderby": {
"required": false,
"default": "name",
"enum": [
"id",
"include",
"name",
"slug",
"term_group",
"description",
"count"
],
"description": "Sort collection by resource attribute.",
"type": "string"
},
"hide_empty": {
"required": false,
"default": false,
"description": "Whether to hide resources not assigned to any products.",
"type": "boolean"
},
"product": {
"required": false,
"description": "Limit result set to resources assigned to a specific product.",
"type": "integer"
},
"slug": {
"required": false,
"description": "Limit result set to resources with a specific slug.",
"type": "string"
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"required": true,
"description": "Name for the resource.",
"type": "string"
},
"slug": {
"required": false,
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string"
},
"description": {
"required": false,
"description": "HTML description of the resource.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/products/tags"
}
},
"/wc/v3/products/tags/(?P<id>[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"name": {
"required": false,
"description": "Tag name.",
"type": "string"
},
"slug": {
"required": false,
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string"
},
"description": {
"required": false,
"description": "HTML description of the resource.",
"type": "string"
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"force": {
"required": false,
"default": false,
"description": "Required to be true, as resource does not support binning.",
"type": "boolean"
}
}
}
]
},
"/wc/v3/products/tags/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"required": false,
"description": "Tag name.",
"type": "string"
},
"slug": {
"required": false,
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string"
},
"description": {
"required": false,
"description": "HTML description of the resource.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/products/tags/batch"
}
},
"/wc/v3/products": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
},
"page": {
"required": false,
"default": 1,
"description": "Current page of the collection.",
"type": "integer"
},
"per_page": {
"required": false,
"default": 10,
"description": "Maximum number of items to be returned in result set.",
"type": "integer"
},
"search": {
"required": false,
"description": "Limit results to those matching a string.",
"type": "string"
},
"after": {
"required": false,
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string"
},
"before": {
"required": false,
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string"
},
"exclude": {
"required": false,
"default": [],
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"include": {
"required": false,
"default": [],
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
}
},
"offset": {
"required": false,
"description": "Offset the result set by a specific number of items.",
"type": "integer"
},
"order": {
"required": false,
"default": "desc",
"enum": [
"asc",
"desc"
],
"description": "Order sort attribute ascending or descending.",
"type": "string"
},
"orderby": {
"required": false,
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"price",
"popularity",
"rating"
],
"description": "Sort collection by object attribute.",
"type": "string"
},
"parent": {
"required": false,
"default": [],
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"parent_exclude": {
"required": false,
"default": [],
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
}
},
"slug": {
"required": false,
"description": "Limit result set to products with a specific slug.",
"type": "string"
},
"status": {
"required": false,
"default": "any",
"enum": [
"any",
"future",
"draft",
"pending",
"private",
"publish"
],
"description": "Limit result set to products assigned a specific status.",
"type": "string"
},
"type": {
"required": false,
"enum": [
"simple",
"grouped",
"external",
"variable",
"bundle"
],
"description": "Limit result set to products assigned a specific type.",
"type": "string"
},
"sku": {
"required": false,
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
"type": "string"
},
"featured": {
"required": false,
"description": "Limit result set to featured products.",
"type": "boolean"
},
"category": {
"required": false,
"description": "Limit result set to products assigned a specific category ID.",
"type": "string"
},
"tag": {
"required": false,
"description": "Limit result set to products assigned a specific tag ID.",
"type": "string"
},
"shipping_class": {
"required": false,
"description": "Limit result set to products assigned a specific shipping class ID.",
"type": "string"
},
"attribute": {
"required": false,
"description": "Limit result set to products with a specific attribute. Use the taxonomy name/attribute slug.",
"type": "string"
},
"attribute_term": {
"required": false,
"description": "Limit result set to products with a specific attribute term ID (requires an assigned attribute).",
"type": "string"
},
"tax_class": {
"required": false,
"enum": [
"standard",
"reduced-rate",
"zero-rate"
],
"description": "Limit result set to products with a specific tax class.",
"type": "string"
},
"on_sale": {
"required": false,
"description": "Limit result set to products on sale.",
"type": "boolean"
},
"min_price": {
"required": false,
"description": "Limit result set to products based on a minimum price.",
"type": "string"
},
"max_price": {
"required": false,
"description": "Limit result set to products based on a maximum price.",
"type": "string"
},
"stock_status": {
"required": false,
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"description": "Limit result set to products with specified stock status.",
"type": "string"
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"required": false,
"description": "Product name.",
"type": "string"
},
"slug": {
"required": false,
"description": "Product slug.",
"type": "string"
},
"date_created": {
"required": false,
"description": "The date the product was created, in the site's timezone.",
"type": "date-time"
},
"date_created_gmt": {
"required": false,
"description": "The date the product was created, as GMT.",
"type": "date-time"
},
"type": {
"required": false,
"default": "simple",
"enum": [
"simple",
"grouped",
"external",
"variable",
"bundle"
],
"description": "Product type.",
"type": "string"
},
"status": {
"required": false,
"default": "publish",
"enum": [
"draft",
"pending",
"private",
"publish",
"future"
],
"description": "Product status (post status).",
"type": "string"
},
"featured": {
"required": false,
"default": false,
"description": "Featured product.",
"type": "boolean"
},
"catalog_visibility": {
"required": false,
"default": "visible",
"enum": [
"visible",
"catalog",
"search",
"hidden"
],
"description": "Catalogue visibility.",
"type": "string"
},
"description": {
"required": false,
"description": "Product description.",
"type": "string"
},
"short_description": {
"required": false,
"description": "Product short description.",
"type": "string"
},
"sku": {
"required": false,
"description": "Unique identifier.",
"type": "string"
},
"regular_price": {
"required": false,
"description": "Product regular price.",
"type": "string"
},
"sale_price": {
"required": false,
"description": "Product sale price.",
"type": "string"
},
"date_on_sale_from": {
"required": false,
"description": "Start date of sale price, in the site's timezone.",
"type": "date-time"
},
"date_on_sale_from_gmt": {
"required": false,
"description": "Start date of sale price, as GMT.",
"type": "date-time"
},
"date_on_sale_to": {
"required": false,
"description": "End date of sale price, in the site's timezone.",
"type": "date-time"
},
"date_on_sale_to_gmt": {
"required": false,
"description": "End date of sale price, in the site's timezone.",
"type": "date-time"
},
"virtual": {
"required": false,
"default": false,
"description": "If the product is virtual.",
"type": "boolean"
},
"downloadable": {
"required": false,
"default": false,
"description": "If the product is downloadable.",
"type": "boolean"
},
"downloads": {
"required": false,
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"download_limit": {
"required": false,
"default": -1,
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer"
},
"download_expiry": {
"required": false,
"default": -1,
"description": "Number of days until access to downloadable files expires.",
"type": "integer"
},
"external_url": {
"required": false,
"description": "Product external URL. Only for external products.",
"type": "string"
},
"button_text": {
"required": false,
"description": "Product external button text. Only for external products.",
"type": "string"
},
"tax_status": {
"required": false,
"default": "taxable",
"enum": [
"taxable",
"shipping",
"none"
],
"description": "Tax status.",
"type": "string"
},
"tax_class": {
"required": false,
"description": "Tax class.",
"type": "string"
},
"manage_stock": {
"required": false,
"default": false,
"description": "Stock management at product level.",
"type": "boolean"
},
"stock_quantity": {
"required": false,
"description": "Stock quantity.",
"type": "integer"
},
"stock_status": {
"required": false,
"default": "instock",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"description": "Controls the stock status of the product.",
"type": "string"
},
"backorders": {
"required": false,
"default": "no",
"enum": [
"no",
"notify",
"yes"
],
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string"
},
"sold_individually": {
"required": false,
"default": false,
"description": "Allow one item to be bought in a single order.",
"type": "boolean"
},
"weight": {
"required": false,
"description": "Product weight (lbs).",
"type": "string"
},
"dimensions": {
"required": false,
"description": "Product dimensions.",
"type": "object"
},
"shipping_class": {
"required": false,
"description": "Shipping class slug.",
"type": "string"
},
"reviews_allowed": {
"required": false,
"default": true,
"description": "Allow reviews.",
"type": "boolean"
},
"upsell_ids": {
"required": false,
"description": "List of up-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"cross_sell_ids": {
"required": false,
"description": "List of cross-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"parent_id": {
"required": false,
"description": "Product parent ID.",
"type": "integer"
},
"purchase_note": {
"required": false,
"description": "Optional note to send the customer after purchase.",
"type": "string"
},
"categories": {
"required": false,
"description": "List of categories.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Category ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Category name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Category slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"tags": {
"required": false,
"description": "List of tags.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tag ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Tag name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Tag slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"images": {
"required": false,
"description": "List of images.",
"type": "object",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": "date-time",
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": "date-time",
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": "date-time",
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": "date-time",
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"attributes": {
"required": false,
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Attribute position.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"visible": {
"description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"variation": {
"description": "Define if the attribute can be used as variation.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"options": {
"description": "List of available term names of the attribute.",
"type": "array",
"items": {
"type": "string"
},
"context": [
"view",
"edit"
]
}
}
}
},
"default_attributes": {
"required": false,
"description": "Defaults variation attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"menu_order": {
"required": false,
"description": "Menu order, used to custom sort products.",
"type": "integer"
},
"meta_data": {
"required": false,
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
},
"bundle_layout": {
"required": false,
"enum": [
"default",
"tabular"
],
"description": "Single-product details page layout. Applicable for bundle-type products only.",
"type": "string"
},
"bundled_items": {
"required": false,
"description": "List of bundled items contained in this product.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Bundled item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"delete": {
"description": "Set to true to delete the bundled item with the specified ID.",
"type": "boolean",
"context": [
"edit"
]
},
"product_id": {
"description": "Bundled product ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"menu_order": {
"description": "Bundled item menu order.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity_min": {
"description": "Minimum bundled item quantity.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity_max": {
"description": "Maximum bundled item quantity.",
"context": [
"view",
"edit"
]
},
"priced_individually": {
"description": "Indicates whether the price of this bundled item is added to the base price of the bundle.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"shipped_individually": {
"description": "Indicates whether the bundled product is shipped separately from the bundle.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"override_title": {
"description": "Indicates whether the title of the bundled product is overridden in front-end and e-mail templates.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"title": {
"description": "Title of the bundled product to display instead of the original product title, if overridden.",
"type": "string",
"context": [
"view",
"edit"
]
},
"override_description": {
"description": "Indicates whether the short description of the bundled product is overridden in front-end templates.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"description": {
"description": "Short description of the bundled product to display instead of the original product short description, if overridden.",
"type": "string",
"context": [
"view",
"edit"
]
},
"optional": {
"description": "Indicates whether the bundled item is optional.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"hide_thumbnail": {
"description": "Indicates whether the bundled product thumbnail is hidden in the single-product template.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"discount": {
"description": "Discount applied to the bundled product, applicable when the Priced Individually option is enabled.",
"type": "string",
"context": [
"view",
"edit"
]
},
"override_variations": {
"description": "Indicates whether variations filtering is active, applicable for variable bundled products only.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"allowed_variations": {
"description": "List of enabled variation IDs, applicable when variations filtering is active.",
"type": "array",
"items": {
"type": "integer"
},
"context": [
"view",
"edit"
]
},
"override_default_variation_attributes": {
"description": "Indicates whether the default variation attribute values are overridden, applicable for variable bundled products only.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"default_variation_attributes": {
"description": "Overridden default variation attribute values, if applicable.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"single_product_visibility": {
"description": "Indicates whether the bundled product is visible in the single-product template.",
"type": "string",
"enum": [
"visible",
"hidden"
],
"context": [
"view",
"edit"
]
},
"cart_visibility": {
"description": "Indicates whether the bundled product is visible in cart templates.",
"type": "string",
"enum": [
"visible",
"hidden"
],
"context": [
"view",
"edit"
]
},
"order_visibility": {
"description": "Indicates whether the bundled product is visible in order/e-mail templates.",
"type": "string",
"enum": [
"visible",
"hidden"
],
"context": [
"view",
"edit"
]
},
"single_product_price_visibility": {
"description": "Indicates whether the bundled product price is visible in the single-product template, applicable when the Priced Individually option is enabled.",
"type": "string",
"enum": [
"visible",
"hidden"
],
"context": [
"view",
"edit"
]
},
"cart_price_visibility": {
"description": "Indicates whether the bundled product price is visible in cart templates, applicable when the Priced Individually option is enabled.",
"type": "string",
"enum": [
"visible",
"hidden"
],
"context": [
"view",
"edit"
]
},
"order_price_visibility": {
"description": "Indicates whether the bundled product price is visible in order/e-mail templates, applicable when the Priced Individually option is enabled.",
"type": "string",
"enum": [
"visible",
"hidden"
],
"context": [
"view",
"edit"
]
},
"stock_status": {
"description": "Stock status of the bundled item, taking minimum quantity into account.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"in_stock",
"on_backorder",
"out_of_stock"
],
"readonly": true
}
}
}
},
"purchase_price": {
"required": false,
"description": "Product's purchase price.",
"type": "number"
},
"supplier_id": {
"required": false,
"description": "The ID of the ATUM Supplier that is linked to this product.",
"type": "integer"
},
"supplier_sku": {
"required": false,
"description": "The Supplier's SKU for this product.",
"type": "string"
},
"atum_controlled": {
"required": false,
"default": false,
"description": "Whether this product is being controlled by ATUM.",
"type": "boolean"
},
"out_stock_date": {
"required": false,
"description": "The date when this product run out of stock.",
"type": "date-time"
},
"out_stock_threshold": {
"required": false,
"description": "Out of stock threshold at product level.",
"type": "number"
},
"inheritable": {
"required": false,
"default": false,
"description": "Whether this product may have children.",
"type": "boolean"
},
"inbound_stock": {
"required": false,
"description": "Product's inbound stock.",
"type": "number"
},
"stock_on_hold": {
"required": false,
"description": "Product's stock on hold.",
"type": "number"
},
"sold_today": {
"required": false,
"description": "Units sold today.",
"type": "number"
},
"sales_last_days": {
"required": false,
"description": "Sales the last 14 days.",
"type": "number"
},
"reserved_stock": {
"required": false,
"description": "Stock set as 'reserved_stock' within Inventory Logs.",
"type": "number"
},
"customer_returns": {
"required": false,
"description": "Stock set as 'customer returns' within Inventory Logs.",
"type": "number"
},
"warehouse_damage": {
"required": false,
"description": "Stock set as 'warehouse damage' within Inventory Logs.",
"type": "number"
},
"lost_in_post": {
"required": false,
"description": "Stock set as 'lost in post' within Inventory Logs.",
"type": "number"
},
"other_logs": {
"required": false,
"description": "Stock set as 'other' within Inventory Logs.",
"type": "number"
},
"out_stock_days": {
"required": false,
"description": "The number of days that the product is Out of stock.",
"type": "integer"
},
"lost_sales": {
"required": false,
"description": "Product lost sales.",
"type": "number"
},
"has_location": {
"required": false,
"description": "Whether this product has any ATUM location set.",
"type": "boolean"
},
"update_date": {
"required": false,
"description": "Last date when the ATUM product data was calculated and saved for this product.",
"type": "date-time"
},
"linked_bom": {
"required": false,
"description": "The BOM linked to this product with their quantities.",
"type": "array",
"items": {
"type": "object",
"properties": {
"bom_id": {
"description": "The linked BOM product ID.",
"type": "integer",
"required": true,
"context": [
"view",
"edit"
]
},
"bom_type": {
"description": "The linked BOM product type.",
"type": "string",
"enum": [
"raw_material",
"product_part"
],
"context": [
"view",
"edit"
]
},
"qty": {
"description": "The linked BOM quantity.",
"type": "number",
"context": [
"view",
"edit"
]
},
"delete": {
"description": "Whether to delete the linked BOM from the product.",
"type": "boolean",
"context": [
"edit"
]
}
}
}
},
"sync_purchase_price": {
"required": false,
"description": "Whether to sync the product's purchase price with the BOM's purchase price.",
"type": "boolean"
},
"bom_sellable": {
"required": false,
"description": "If the product is a BOM, indicates whether the product is sellable.",
"type": "boolean"
},
"minimum_threshold": {
"required": false,
"description": "If the product is a BOM, indicates the product's minimum threshold.",
"type": "number"
},
"available_to_purchase": {
"required": false,
"description": "If the product is a BOM, indicates the product's available to purchase amount.",
"type": "number"
},
"selling_priority": {
"required": false,
"description": "If the product is a BOM, indicates the product's selling priority.",
"type": "integer"
},
"calculated_stock": {
"required": false,
"description": "If the BOM stock control is enabled and the product has linked BOM, it indicates the calculated stock quantity.",
"type": "number"
},
"multi_inventory": {
"required": false,
"enum": [
"yes",
"no",
"global"
],
"description": "The Multi Inventory status for this product.",
"type": "string"
},
"inventory_sorting_mode": {
"required": false,
"enum": [
"fifo",
"lifo",
"bbe",
"manual",
"global"
],
"description": "The sorting mode specified for inventory selling priority.",
"type": "string"
},
"inventory_iteration": {
"required": false,
"enum": [
"use_next",
"out_of_stock",
"global"
],
"description": "What to do when the first selling inventory runs out of stock.",
"type": "string"
},
"expirable_inventories": {
"required": false,
"enum": [
"yes",
"no",
"global"
],
"description": "Set the inventories as 'Out of Stock' when reaching their BBE dates.",
"type": "string"
},
"price_per_inventory": {
"required": false,
"enum": [
"yes",
"no",
"global"
],
"description": "Allow distinct inventories to have distinct prices.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/products"
}
},
"/wc/v3/products/(?P<id>[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"name": {
"required": false,
"description": "Product name.",
"type": "string"
},
"slug": {
"required": false,
"description": "Product slug.",
"type": "string"
},
"date_created": {
"required": false,
"description": "The date the product was created, in the site's timezone.",
"type": "date-time"
},
"date_created_gmt": {
"required": false,
"description": "The date the product was created, as GMT.",
"type": "date-time"
},
"type": {
"required": false,
"enum": [
"simple",
"grouped",
"external",
"variable",
"bundle"
],
"description": "Product type.",
"type": "string"
},
"status": {
"required": false,
"enum": [
"draft",
"pending",
"private",
"publish",
"future"
],
"description": "Product status (post status).",
"type": "string"
},
"featured": {
"required": false,
"description": "Featured product.",
"type": "boolean"
},
"catalog_visibility": {
"required": false,
"enum": [
"visible",
"catalog",
"search",
"hidden"
],
"description": "Catalogue visibility.",
"type": "string"
},
"description": {
"required": false,
"description": "Product description.",
"type": "string"
},
"short_description": {
"required": false,
"description": "Product short description.",
"type": "string"
},
"sku": {
"required": false,
"description": "Unique identifier.",
"type": "string"
},
"regular_price": {
"required": false,
"description": "Product regular price.",
"type": "string"
},
"sale_price": {
"required": false,
"description": "Product sale price.",
"type": "string"
},
"date_on_sale_from": {
"required": false,
"description": "Start date of sale price, in the site's timezone.",
"type": "date-time"
},
"date_on_sale_from_gmt": {
"required": false,
"description": "Start date of sale price, as GMT.",
"type": "date-time"
},
"date_on_sale_to": {
"required": false,
"description": "End date of sale price, in the site's timezone.",
"type": "date-time"
},
"date_on_sale_to_gmt": {
"required": false,
"description": "End date of sale price, in the site's timezone.",
"type": "date-time"
},
"virtual": {
"required": false,
"description": "If the product is virtual.",
"type": "boolean"
},
"downloadable": {
"required": false,
"description": "If the product is downloadable.",
"type": "boolean"
},
"downloads": {
"required": false,
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"download_limit": {
"required": false,
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer"
},
"download_expiry": {
"required": false,
"description": "Number of days until access to downloadable files expires.",
"type": "integer"
},
"external_url": {
"required": false,
"description": "Product external URL. Only for external products.",
"type": "string"
},
"button_text": {
"required": false,
"description": "Product external button text. Only for external products.",
"type": "string"
},
"tax_status": {
"required": false,
"enum": [
"taxable",
"shipping",
"none"
],
"description": "Tax status.",
"type": "string"
},
"tax_class": {
"required": false,
"description": "Tax class.",
"type": "string"
},
"manage_stock": {
"required": false,
"description": "Stock management at product level.",
"type": "boolean"
},
"stock_quantity": {
"required": false,
"description": "Stock quantity.",
"type": "integer"
},
"stock_status": {
"required": false,
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"description": "Controls the stock status of the product.",
"type": "string"
},
"backorders": {
"required": false,
"enum": [
"no",
"notify",
"yes"
],
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string"
},
"sold_individually": {
"required": false,
"description": "Allow one item to be bought in a single order.",
"type": "boolean"
},
"weight": {
"required": false,
"description": "Product weight (lbs).",
"type": "string"
},
"dimensions": {
"required": false,
"description": "Product dimensions.",
"type": "object"
},
"shipping_class": {
"required": false,
"description": "Shipping class slug.",
"type": "string"
},
"reviews_allowed": {
"required": false,
"description": "Allow reviews.",
"type": "boolean"
},
"upsell_ids": {
"required": false,
"description": "List of up-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"cross_sell_ids": {
"required": false,
"description": "List of cross-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"parent_id": {
"required": false,
"description": "Product parent ID.",
"type": "integer"
},
"purchase_note": {
"required": false,
"description": "Optional note to send the customer after purchase.",
"type": "string"
},
"categories": {
"required": false,
"description": "List of categories.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Category ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Category name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Category slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"tags": {
"required": false,
"description": "List of tags.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tag ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Tag name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Tag slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"images": {
"required": false,
"description": "List of images.",
"type": "object",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": "date-time",
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": "date-time",
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": "date-time",
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": "date-time",
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"attributes": {
"required": false,
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Attribute position.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"visible": {
"description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"variation": {
"description": "Define if the attribute can be used as variation.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"options": {
"description": "List of available term names of the attribute.",
"type": "array",
"items": {
"type": "string"
},
"context": [
"view",
"edit"
]
}
}
}
},
"default_attributes": {
"required": false,
"description": "Defaults variation attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"menu_order": {
"required": false,
"description": "Menu order, used to custom sort products.",
"type": "integer"
},
"meta_data": {
"required": false,
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
},
"bundle_layout": {
"required": false,
"enum": [
"default",
"tabular"
],
"description": "Single-product details page layout. Applicable for bundle-type products only.",
"type": "string"
},
"bundled_items": {
"required": false,
"description": "List of bundled items contained in this product.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Bundled item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"delete": {
"description": "Set to true to delete the bundled item with the specified ID.",
"type": "boolean",
"context": [
"edit"
]
},
"product_id": {
"description": "Bundled product ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"menu_order": {
"description": "Bundled item menu order.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity_min": {
"description": "Minimum bundled item quantity.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity_max": {
"description": "Maximum bundled item quantity.",
"context": [
"view",
"edit"
]
},
"priced_individually": {
"description": "Indicates whether the price of this bundled item is added to the base price of the bundle.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"shipped_individually": {
"description": "Indicates whether the bundled product is shipped separately from the bundle.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"override_title": {
"description": "Indicates whether the title of the bundled product is overridden in front-end and e-mail templates.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"title": {
"description": "Title of the bundled product to display instead of the original product title, if overridden.",
"type": "string",
"context": [
"view",
"edit"
]
},
"override_description": {
"description": "Indicates whether the short description of the bundled product is overridden in front-end templates.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"description": {
"description": "Short description of the bundled product to display instead of the original product short description, if overridden.",
"type": "string",
"context": [
"view",
"edit"
]
},
"optional": {
"description": "Indicates whether the bundled item is optional.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"hide_thumbnail": {
"description": "Indicates whether the bundled product thumbnail is hidden in the single-product template.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"discount": {
"description": "Discount applied to the bundled product, applicable when the Priced Individually option is enabled.",
"type": "string",
"context": [
"view",
"edit"
]
},
"override_variations": {
"description": "Indicates whether variations filtering is active, applicable for variable bundled products only.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"allowed_variations": {
"description": "List of enabled variation IDs, applicable when variations filtering is active.",
"type": "array",
"items": {
"type": "integer"
},
"context": [
"view",
"edit"
]
},
"override_default_variation_attributes": {
"description": "Indicates whether the default variation attribute values are overridden, applicable for variable bundled products only.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"default_variation_attributes": {
"description": "Overridden default variation attribute values, if applicable.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"single_product_visibility": {
"description": "Indicates whether the bundled product is visible in the single-product template.",
"type": "string",
"enum": [
"visible",
"hidden"
],
"context": [
"view",
"edit"
]
},
"cart_visibility": {
"description": "Indicates whether the bundled product is visible in cart templates.",
"type": "string",
"enum": [
"visible",
"hidden"
],
"context": [
"view",
"edit"
]
},
"order_visibility": {
"description": "Indicates whether the bundled product is visible in order/e-mail templates.",
"type": "string",
"enum": [
"visible",
"hidden"
],
"context": [
"view",
"edit"
]
},
"single_product_price_visibility": {
"description": "Indicates whether the bundled product price is visible in the single-product template, applicable when the Priced Individually option is enabled.",
"type": "string",
"enum": [
"visible",
"hidden"
],
"context": [
"view",
"edit"
]
},
"cart_price_visibility": {
"description": "Indicates whether the bundled product price is visible in cart templates, applicable when the Priced Individually option is enabled.",
"type": "string",
"enum": [
"visible",
"hidden"
],
"context": [
"view",
"edit"
]
},
"order_price_visibility": {
"description": "Indicates whether the bundled product price is visible in order/e-mail templates, applicable when the Priced Individually option is enabled.",
"type": "string",
"enum": [
"visible",
"hidden"
],
"context": [
"view",
"edit"
]
},
"stock_status": {
"description": "Stock status of the bundled item, taking minimum quantity into account.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"in_stock",
"on_backorder",
"out_of_stock"
],
"readonly": true
}
}
}
},
"purchase_price": {
"required": false,
"description": "Product's purchase price.",
"type": "number"
},
"supplier_id": {
"required": false,
"description": "The ID of the ATUM Supplier that is linked to this product.",
"type": "integer"
},
"supplier_sku": {
"required": false,
"description": "The Supplier's SKU for this product.",
"type": "string"
},
"atum_controlled": {
"required": false,
"description": "Whether this product is being controlled by ATUM.",
"type": "boolean"
},
"out_stock_date": {
"required": false,
"description": "The date when this product run out of stock.",
"type": "date-time"
},
"out_stock_threshold": {
"required": false,
"description": "Out of stock threshold at product level.",
"type": "number"
},
"inheritable": {
"required": false,
"description": "Whether this product may have children.",
"type": "boolean"
},
"inbound_stock": {
"required": false,
"description": "Product's inbound stock.",
"type": "number"
},
"stock_on_hold": {
"required": false,
"description": "Product's stock on hold.",
"type": "number"
},
"sold_today": {
"required": false,
"description": "Units sold today.",
"type": "number"
},
"sales_last_days": {
"required": false,
"description": "Sales the last 14 days.",
"type": "number"
},
"reserved_stock": {
"required": false,
"description": "Stock set as 'reserved_stock' within Inventory Logs.",
"type": "number"
},
"customer_returns": {
"required": false,
"description": "Stock set as 'customer returns' within Inventory Logs.",
"type": "number"
},
"warehouse_damage": {
"required": false,
"description": "Stock set as 'warehouse damage' within Inventory Logs.",
"type": "number"
},
"lost_in_post": {
"required": false,
"description": "Stock set as 'lost in post' within Inventory Logs.",
"type": "number"
},
"other_logs": {
"required": false,
"description": "Stock set as 'other' within Inventory Logs.",
"type": "number"
},
"out_stock_days": {
"required": false,
"description": "The number of days that the product is Out of stock.",
"type": "integer"
},
"lost_sales": {
"required": false,
"description": "Product lost sales.",
"type": "number"
},
"has_location": {
"required": false,
"description": "Whether this product has any ATUM location set.",
"type": "boolean"
},
"update_date": {
"required": false,
"description": "Last date when the ATUM product data was calculated and saved for this product.",
"type": "date-time"
},
"linked_bom": {
"required": false,
"description": "The BOM linked to this product with their quantities.",
"type": "array",
"items": {
"type": "object",
"properties": {
"bom_id": {
"description": "The linked BOM product ID.",
"type": "integer",
"required": true,
"context": [
"view",
"edit"
]
},
"bom_type": {
"description": "The linked BOM product type.",
"type": "string",
"enum": [
"raw_material",
"product_part"
],
"context": [
"view",
"edit"
]
},
"qty": {
"description": "The linked BOM quantity.",
"type": "number",
"context": [
"view",
"edit"
]
},
"delete": {
"description": "Whether to delete the linked BOM from the product.",
"type": "boolean",
"context": [
"edit"
]
}
}
}
},
"sync_purchase_price": {
"required": false,
"description": "Whether to sync the product's purchase price with the BOM's purchase price.",
"type": "boolean"
},
"bom_sellable": {
"required": false,
"description": "If the product is a BOM, indicates whether the product is sellable.",
"type": "boolean"
},
"minimum_threshold": {
"required": false,
"description": "If the product is a BOM, indicates the product's minimum threshold.",
"type": "number"
},
"available_to_purchase": {
"required": false,
"description": "If the product is a BOM, indicates the product's available to purchase amount.",
"type": "number"
},
"selling_priority": {
"required": false,
"description": "If the product is a BOM, indicates the product's selling priority.",
"type": "integer"
},
"calculated_stock": {
"required": false,
"description": "If the BOM stock control is enabled and the product has linked BOM, it indicates the calculated stock quantity.",
"type": "number"
},
"multi_inventory": {
"required": false,
"enum": [
"yes",
"no",
"global"
],
"description": "The Multi Inventory status for this product.",
"type": "string"
},
"inventory_sorting_mode": {
"required": false,
"enum": [
"fifo",
"lifo",
"bbe",
"manual",
"global"
],
"description": "The sorting mode specified for inventory selling priority.",
"type": "string"
},
"inventory_iteration": {
"required": false,
"enum": [
"use_next",
"out_of_stock",
"global"
],
"description": "What to do when the first selling inventory runs out of stock.",
"type": "string"
},
"expirable_inventories": {
"required": false,
"enum": [
"yes",
"no",
"global"
],
"description": "Set the inventories as 'Out of Stock' when reaching their BBE dates.",
"type": "string"
},
"price_per_inventory": {
"required": false,
"enum": [
"yes",
"no",
"global"
],
"description": "Allow distinct inventories to have distinct prices.",
"type": "string"
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"force": {
"required": false,
"default": false,
"description": "Whether to bypass bin and force deletion.",
"type": "boolean"
}
}
}
]
},
"/wc/v3/products/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"required": false,
"description": "Product name.",
"type": "string"
},
"slug": {
"required": false,
"description": "Product slug.",
"type": "string"
},
"date_created": {
"required": false,
"description": "The date the product was created, in the site's timezone.",
"type": "date-time"
},
"date_created_gmt": {
"required": false,
"description": "The date the product was created, as GMT.",
"type": "date-time"
},
"type": {
"required": false,
"enum": [
"simple",
"grouped",
"external",
"variable",
"bundle"
],
"description": "Product type.",
"type": "string"
},
"status": {
"required": false,
"enum": [
"draft",
"pending",
"private",
"publish",
"future"
],
"description": "Product status (post status).",
"type": "string"
},
"featured": {
"required": false,
"description": "Featured product.",
"type": "boolean"
},
"catalog_visibility": {
"required": false,
"enum": [
"visible",
"catalog",
"search",
"hidden"
],
"description": "Catalogue visibility.",
"type": "string"
},
"description": {
"required": false,
"description": "Product description.",
"type": "string"
},
"short_description": {
"required": false,
"description": "Product short description.",
"type": "string"
},
"sku": {
"required": false,
"description": "Unique identifier.",
"type": "string"
},
"regular_price": {
"required": false,
"description": "Product regular price.",
"type": "string"
},
"sale_price": {
"required": false,
"description": "Product sale price.",
"type": "string"
},
"date_on_sale_from": {
"required": false,
"description": "Start date of sale price, in the site's timezone.",
"type": "date-time"
},
"date_on_sale_from_gmt": {
"required": false,
"description": "Start date of sale price, as GMT.",
"type": "date-time"
},
"date_on_sale_to": {
"required": false,
"description": "End date of sale price, in the site's timezone.",
"type": "date-time"
},
"date_on_sale_to_gmt": {
"required": false,
"description": "End date of sale price, in the site's timezone.",
"type": "date-time"
},
"virtual": {
"required": false,
"description": "If the product is virtual.",
"type": "boolean"
},
"downloadable": {
"required": false,
"description": "If the product is downloadable.",
"type": "boolean"
},
"downloads": {
"required": false,
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"download_limit": {
"required": false,
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer"
},
"download_expiry": {
"required": false,
"description": "Number of days until access to downloadable files expires.",
"type": "integer"
},
"external_url": {
"required": false,
"description": "Product external URL. Only for external products.",
"type": "string"
},
"button_text": {
"required": false,
"description": "Product external button text. Only for external products.",
"type": "string"
},
"tax_status": {
"required": false,
"enum": [
"taxable",
"shipping",
"none"
],
"description": "Tax status.",
"type": "string"
},
"tax_class": {
"required": false,
"description": "Tax class.",
"type": "string"
},
"manage_stock": {
"required": false,
"description": "Stock management at product level.",
"type": "boolean"
},
"stock_quantity": {
"required": false,
"description": "Stock quantity.",
"type": "integer"
},
"stock_status": {
"required": false,
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"description": "Controls the stock status of the product.",
"type": "string"
},
"backorders": {
"required": false,
"enum": [
"no",
"notify",
"yes"
],
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string"
},
"sold_individually": {
"required": false,
"description": "Allow one item to be bought in a single order.",
"type": "boolean"
},
"weight": {
"required": false,
"description": "Product weight (lbs).",
"type": "string"
},
"dimensions": {
"required": false,
"description": "Product dimensions.",
"type": "object"
},
"shipping_class": {
"required": false,
"description": "Shipping class slug.",
"type": "string"
},
"reviews_allowed": {
"required": false,
"description": "Allow reviews.",
"type": "boolean"
},
"upsell_ids": {
"required": false,
"description": "List of up-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"cross_sell_ids": {
"required": false,
"description": "List of cross-sell products IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"parent_id": {
"required": false,
"description": "Product parent ID.",
"type": "integer"
},
"purchase_note": {
"required": false,
"description": "Optional note to send the customer after purchase.",
"type": "string"
},
"categories": {
"required": false,
"description": "List of categories.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Category ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Category name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Category slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"tags": {
"required": false,
"description": "List of tags.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tag ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Tag name.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"slug": {
"description": "Tag slug.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"images": {
"required": false,
"description": "List of images.",
"type": "object",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": "date-time",
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT.",
"type": "date-time",
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was last modified, in the site's timezone.",
"type": "date-time",
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was last modified, as GMT.",
"type": "date-time",
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"attributes": {
"required": false,
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"position": {
"description": "Attribute position.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"visible": {
"description": "Define if the attribute is visible on the \"Additional information\" tab in the product's page.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"variation": {
"description": "Define if the attribute can be used as variation.",
"type": "boolean",
"default": false,
"context": [
"view",
"edit"
]
},
"options": {
"description": "List of available term names of the attribute.",
"type": "array",
"items": {
"type": "string"
},
"context": [
"view",
"edit"
]
}
}
}
},
"default_attributes": {
"required": false,
"description": "Defaults variation attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"menu_order": {
"required": false,
"description": "Menu order, used to custom sort products.",
"type": "integer"
},
"meta_data": {
"required": false,
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
},
"bundle_layout": {
"required": false,
"enum": [
"default",
"tabular"
],
"description": "Single-product details page layout. Applicable for bundle-type products only.",
"type": "string"
},
"bundled_items": {
"required": false,
"description": "List of bundled items contained in this product.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Bundled item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"delete": {
"description": "Set to true to delete the bundled item with the specified ID.",
"type": "boolean",
"context": [
"edit"
]
},
"product_id": {
"description": "Bundled product ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"menu_order": {
"description": "Bundled item menu order.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity_min": {
"description": "Minimum bundled item quantity.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity_max": {
"description": "Maximum bundled item quantity.",
"context": [
"view",
"edit"
]
},
"priced_individually": {
"description": "Indicates whether the price of this bundled item is added to the base price of the bundle.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"shipped_individually": {
"description": "Indicates whether the bundled product is shipped separately from the bundle.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"override_title": {
"description": "Indicates whether the title of the bundled product is overridden in front-end and e-mail templates.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"title": {
"description": "Title of the bundled product to display instead of the original product title, if overridden.",
"type": "string",
"context": [
"view",
"edit"
]
},
"override_description": {
"description": "Indicates whether the short description of the bundled product is overridden in front-end templates.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"description": {
"description": "Short description of the bundled product to display instead of the original product short description, if overridden.",
"type": "string",
"context": [
"view",
"edit"
]
},
"optional": {
"description": "Indicates whether the bundled item is optional.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"hide_thumbnail": {
"description": "Indicates whether the bundled product thumbnail is hidden in the single-product template.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"discount": {
"description": "Discount applied to the bundled product, applicable when the Priced Individually option is enabled.",
"type": "string",
"context": [
"view",
"edit"
]
},
"override_variations": {
"description": "Indicates whether variations filtering is active, applicable for variable bundled products only.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"allowed_variations": {
"description": "List of enabled variation IDs, applicable when variations filtering is active.",
"type": "array",
"items": {
"type": "integer"
},
"context": [
"view",
"edit"
]
},
"override_default_variation_attributes": {
"description": "Indicates whether the default variation attribute values are overridden, applicable for variable bundled products only.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"default_variation_attributes": {
"description": "Overridden default variation attribute values, if applicable.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"single_product_visibility": {
"description": "Indicates whether the bundled product is visible in the single-product template.",
"type": "string",
"enum": [
"visible",
"hidden"
],
"context": [
"view",
"edit"
]
},
"cart_visibility": {
"description": "Indicates whether the bundled product is visible in cart templates.",
"type": "string",
"enum": [
"visible",
"hidden"
],
"context": [
"view",
"edit"
]
},
"order_visibility": {
"description": "Indicates whether the bundled product is visible in order/e-mail templates.",
"type": "string",
"enum": [
"visible",
"hidden"
],
"context": [
"view",
"edit"
]
},
"single_product_price_visibility": {
"description": "Indicates whether the bundled product price is visible in the single-product template, applicable when the Priced Individually option is enabled.",
"type": "string",
"enum": [
"visible",
"hidden"
],
"context": [
"view",
"edit"
]
},
"cart_price_visibility": {
"description": "Indicates whether the bundled product price is visible in cart templates, applicable when the Priced Individually option is enabled.",
"type": "string",
"enum": [
"visible",
"hidden"
],
"context": [
"view",
"edit"
]
},
"order_price_visibility": {
"description": "Indicates whether the bundled product price is visible in order/e-mail templates, applicable when the Priced Individually option is enabled.",
"type": "string",
"enum": [
"visible",
"hidden"
],
"context": [
"view",
"edit"
]
},
"stock_status": {
"description": "Stock status of the bundled item, taking minimum quantity into account.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"in_stock",
"on_backorder",
"out_of_stock"
],
"readonly": true
}
}
}
},
"purchase_price": {
"required": false,
"description": "Product's purchase price.",
"type": "number"
},
"supplier_id": {
"required": false,
"description": "The ID of the ATUM Supplier that is linked to this product.",
"type": "integer"
},
"supplier_sku": {
"required": false,
"description": "The Supplier's SKU for this product.",
"type": "string"
},
"atum_controlled": {
"required": false,
"description": "Whether this product is being controlled by ATUM.",
"type": "boolean"
},
"out_stock_date": {
"required": false,
"description": "The date when this product run out of stock.",
"type": "date-time"
},
"out_stock_threshold": {
"required": false,
"description": "Out of stock threshold at product level.",
"type": "number"
},
"inheritable": {
"required": false,
"description": "Whether this product may have children.",
"type": "boolean"
},
"inbound_stock": {
"required": false,
"description": "Product's inbound stock.",
"type": "number"
},
"stock_on_hold": {
"required": false,
"description": "Product's stock on hold.",
"type": "number"
},
"sold_today": {
"required": false,
"description": "Units sold today.",
"type": "number"
},
"sales_last_days": {
"required": false,
"description": "Sales the last 14 days.",
"type": "number"
},
"reserved_stock": {
"required": false,
"description": "Stock set as 'reserved_stock' within Inventory Logs.",
"type": "number"
},
"customer_returns": {
"required": false,
"description": "Stock set as 'customer returns' within Inventory Logs.",
"type": "number"
},
"warehouse_damage": {
"required": false,
"description": "Stock set as 'warehouse damage' within Inventory Logs.",
"type": "number"
},
"lost_in_post": {
"required": false,
"description": "Stock set as 'lost in post' within Inventory Logs.",
"type": "number"
},
"other_logs": {
"required": false,
"description": "Stock set as 'other' within Inventory Logs.",
"type": "number"
},
"out_stock_days": {
"required": false,
"description": "The number of days that the product is Out of stock.",
"type": "integer"
},
"lost_sales": {
"required": false,
"description": "Product lost sales.",
"type": "number"
},
"has_location": {
"required": false,
"description": "Whether this product has any ATUM location set.",
"type": "boolean"
},
"update_date": {
"required": false,
"description": "Last date when the ATUM product data was calculated and saved for this product.",
"type": "date-time"
},
"linked_bom": {
"required": false,
"description": "The BOM linked to this product with their quantities.",
"type": "array",
"items": {
"type": "object",
"properties": {
"bom_id": {
"description": "The linked BOM product ID.",
"type": "integer",
"required": true,
"context": [
"view",
"edit"
]
},
"bom_type": {
"description": "The linked BOM product type.",
"type": "string",
"enum": [
"raw_material",
"product_part"
],
"context": [
"view",
"edit"
]
},
"qty": {
"description": "The linked BOM quantity.",
"type": "number",
"context": [
"view",
"edit"
]
},
"delete": {
"description": "Whether to delete the linked BOM from the product.",
"type": "boolean",
"context": [
"edit"
]
}
}
}
},
"sync_purchase_price": {
"required": false,
"description": "Whether to sync the product's purchase price with the BOM's purchase price.",
"type": "boolean"
},
"bom_sellable": {
"required": false,
"description": "If the product is a BOM, indicates whether the product is sellable.",
"type": "boolean"
},
"minimum_threshold": {
"required": false,
"description": "If the product is a BOM, indicates the product's minimum threshold.",
"type": "number"
},
"available_to_purchase": {
"required": false,
"description": "If the product is a BOM, indicates the product's available to purchase amount.",
"type": "number"
},
"selling_priority": {
"required": false,
"description": "If the product is a BOM, indicates the product's selling priority.",
"type": "integer"
},
"calculated_stock": {
"required": false,
"description": "If the BOM stock control is enabled and the product has linked BOM, it indicates the calculated stock quantity.",
"type": "number"
},
"multi_inventory": {
"required": false,
"enum": [
"yes",
"no",
"global"
],
"description": "The Multi Inventory status for this product.",
"type": "string"
},
"inventory_sorting_mode": {
"required": false,
"enum": [
"fifo",
"lifo",
"bbe",
"manual",
"global"
],
"description": "The sorting mode specified for inventory selling priority.",
"type": "string"
},
"inventory_iteration": {
"required": false,
"enum": [
"use_next",
"out_of_stock",
"global"
],
"description": "What to do when the first selling inventory runs out of stock.",
"type": "string"
},
"expirable_inventories": {
"required": false,
"enum": [
"yes",
"no",
"global"
],
"description": "Set the inventories as 'Out of Stock' when reaching their BBE dates.",
"type": "string"
},
"price_per_inventory": {
"required": false,
"enum": [
"yes",
"no",
"global"
],
"description": "Allow distinct inventories to have distinct prices.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/products/batch"
}
},
"/wc/v3/products/(?P<product_id>[\\d]+)/variations": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"product_id": {
"required": false,
"description": "Unique identifier for the variable product.",
"type": "integer"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
},
"page": {
"required": false,
"default": 1,
"description": "Current page of the collection.",
"type": "integer"
},
"per_page": {
"required": false,
"default": 10,
"description": "Maximum number of items to be returned in result set.",
"type": "integer"
},
"search": {
"required": false,
"description": "Limit results to those matching a string.",
"type": "string"
},
"after": {
"required": false,
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string"
},
"before": {
"required": false,
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string"
},
"exclude": {
"required": false,
"default": [],
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"include": {
"required": false,
"default": [],
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
}
},
"offset": {
"required": false,
"description": "Offset the result set by a specific number of items.",
"type": "integer"
},
"order": {
"required": false,
"default": "desc",
"enum": [
"asc",
"desc"
],
"description": "Order sort attribute ascending or descending.",
"type": "string"
},
"orderby": {
"required": false,
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug"
],
"description": "Sort collection by object attribute.",
"type": "string"
},
"parent": {
"required": false,
"default": [],
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"parent_exclude": {
"required": false,
"default": [],
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
}
},
"slug": {
"required": false,
"description": "Limit result set to products with a specific slug.",
"type": "string"
},
"status": {
"required": false,
"default": "any",
"enum": [
"any",
"future",
"draft",
"pending",
"private",
"publish"
],
"description": "Limit result set to products assigned a specific status.",
"type": "string"
},
"sku": {
"required": false,
"description": "Limit result set to products with specific SKU(s). Use commas to separate.",
"type": "string"
},
"tax_class": {
"required": false,
"enum": [
"standard",
"reduced-rate",
"zero-rate"
],
"description": "Limit result set to products with a specific tax class.",
"type": "string"
},
"on_sale": {
"required": false,
"description": "Limit result set to products on sale.",
"type": "boolean"
},
"min_price": {
"required": false,
"description": "Limit result set to products based on a minimum price.",
"type": "string"
},
"max_price": {
"required": false,
"description": "Limit result set to products based on a maximum price.",
"type": "string"
},
"stock_status": {
"required": false,
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"description": "Limit result set to products with specified stock status.",
"type": "string"
}
}
},
{
"methods": [
"POST"
],
"args": {
"product_id": {
"required": false,
"description": "Unique identifier for the variable product.",
"type": "integer"
},
"description": {
"required": false,
"description": "Variation description.",
"type": "string"
},
"sku": {
"required": false,
"description": "Unique identifier.",
"type": "string"
},
"regular_price": {
"required": false,
"description": "Variation regular price.",
"type": "string"
},
"sale_price": {
"required": false,
"description": "Variation sale price.",
"type": "string"
},
"date_on_sale_from": {
"required": false,
"description": "Start date of sale price, in the site's timezone.",
"type": "date-time"
},
"date_on_sale_from_gmt": {
"required": false,
"description": "Start date of sale price, as GMT.",
"type": "date-time"
},
"date_on_sale_to": {
"required": false,
"description": "End date of sale price, in the site's timezone.",
"type": "date-time"
},
"date_on_sale_to_gmt": {
"required": false,
"description": "End date of sale price, in the site's timezone.",
"type": "date-time"
},
"status": {
"required": false,
"default": "publish",
"enum": [
"draft",
"pending",
"private",
"publish"
],
"description": "Variation status.",
"type": "string"
},
"virtual": {
"required": false,
"default": false,
"description": "If the variation is virtual.",
"type": "boolean"
},
"downloadable": {
"required": false,
"default": false,
"description": "If the variation is downloadable.",
"type": "boolean"
},
"downloads": {
"required": false,
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"download_limit": {
"required": false,
"default": -1,
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer"
},
"download_expiry": {
"required": false,
"default": -1,
"description": "Number of days until access to downloadable files expires.",
"type": "integer"
},
"tax_status": {
"required": false,
"default": "taxable",
"enum": [
"taxable",
"shipping",
"none"
],
"description": "Tax status.",
"type": "string"
},
"tax_class": {
"required": false,
"description": "Tax class.",
"type": "string"
},
"manage_stock": {
"required": false,
"default": false,
"description": "Stock management at variation level.",
"type": "boolean"
},
"stock_quantity": {
"required": false,
"description": "Stock quantity.",
"type": "integer"
},
"stock_status": {
"required": false,
"default": "instock",
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"description": "Controls the stock status of the product.",
"type": "string"
},
"backorders": {
"required": false,
"default": "no",
"enum": [
"no",
"notify",
"yes"
],
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string"
},
"weight": {
"required": false,
"description": "Variation weight (lbs).",
"type": "string"
},
"dimensions": {
"required": false,
"description": "Variation dimensions.",
"type": "object"
},
"shipping_class": {
"required": false,
"description": "Shipping class slug.",
"type": "string"
},
"image": {
"required": false,
"description": "Variation image data.",
"type": "object"
},
"attributes": {
"required": false,
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"menu_order": {
"required": false,
"description": "Menu order, used to custom sort products.",
"type": "integer"
},
"meta_data": {
"required": false,
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
},
"purchase_price": {
"required": false,
"description": "Product's purchase price.",
"type": "number"
},
"supplier_id": {
"required": false,
"description": "The ID of the ATUM Supplier that is linked to this product.",
"type": "integer"
},
"supplier_sku": {
"required": false,
"description": "The Supplier's SKU for this product.",
"type": "string"
},
"atum_controlled": {
"required": false,
"default": false,
"description": "Whether this product is being controlled by ATUM.",
"type": "boolean"
},
"out_stock_date": {
"required": false,
"description": "The date when this product run out of stock.",
"type": "date-time"
},
"out_stock_threshold": {
"required": false,
"description": "Out of stock threshold at product level.",
"type": "number"
},
"inheritable": {
"required": false,
"default": false,
"description": "Whether this product may have children.",
"type": "boolean"
},
"inbound_stock": {
"required": false,
"description": "Product's inbound stock.",
"type": "number"
},
"stock_on_hold": {
"required": false,
"description": "Product's stock on hold.",
"type": "number"
},
"sold_today": {
"required": false,
"description": "Units sold today.",
"type": "number"
},
"sales_last_days": {
"required": false,
"description": "Sales the last 14 days.",
"type": "number"
},
"reserved_stock": {
"required": false,
"description": "Stock set as 'reserved_stock' within Inventory Logs.",
"type": "number"
},
"customer_returns": {
"required": false,
"description": "Stock set as 'customer returns' within Inventory Logs.",
"type": "number"
},
"warehouse_damage": {
"required": false,
"description": "Stock set as 'warehouse damage' within Inventory Logs.",
"type": "number"
},
"lost_in_post": {
"required": false,
"description": "Stock set as 'lost in post' within Inventory Logs.",
"type": "number"
},
"other_logs": {
"required": false,
"description": "Stock set as 'other' within Inventory Logs.",
"type": "number"
},
"out_stock_days": {
"required": false,
"description": "The number of days that the product is Out of stock.",
"type": "integer"
},
"lost_sales": {
"required": false,
"description": "Product lost sales.",
"type": "number"
},
"has_location": {
"required": false,
"description": "Whether this product has any ATUM location set.",
"type": "boolean"
},
"update_date": {
"required": false,
"description": "Last date when the ATUM product data was calculated and saved for this product.",
"type": "date-time"
},
"linked_bom": {
"required": false,
"description": "The BOM linked to this product with their quantities.",
"type": "array",
"items": {
"type": "object",
"properties": {
"bom_id": {
"description": "The linked BOM product ID.",
"type": "integer",
"required": true,
"context": [
"view",
"edit"
]
},
"bom_type": {
"description": "The linked BOM product type.",
"type": "string",
"enum": [
"raw_material",
"product_part"
],
"context": [
"view",
"edit"
]
},
"qty": {
"description": "The linked BOM quantity.",
"type": "number",
"context": [
"view",
"edit"
]
},
"delete": {
"description": "Whether to delete the linked BOM from the product.",
"type": "boolean",
"context": [
"edit"
]
}
}
}
},
"sync_purchase_price": {
"required": false,
"description": "Whether to sync the product's purchase price with the BOM's purchase price.",
"type": "boolean"
},
"bom_sellable": {
"required": false,
"description": "If the product is a BOM, indicates whether the product is sellable.",
"type": "boolean"
},
"minimum_threshold": {
"required": false,
"description": "If the product is a BOM, indicates the product's minimum threshold.",
"type": "number"
},
"available_to_purchase": {
"required": false,
"description": "If the product is a BOM, indicates the product's available to purchase amount.",
"type": "number"
},
"selling_priority": {
"required": false,
"description": "If the product is a BOM, indicates the product's selling priority.",
"type": "integer"
},
"calculated_stock": {
"required": false,
"description": "If the BOM stock control is enabled and the product has linked BOM, it indicates the calculated stock quantity.",
"type": "number"
},
"multi_inventory": {
"required": false,
"enum": [
"yes",
"no",
"global"
],
"description": "The Multi Inventory status for this product.",
"type": "string"
},
"inventory_sorting_mode": {
"required": false,
"enum": [
"fifo",
"lifo",
"bbe",
"manual",
"global"
],
"description": "The sorting mode specified for inventory selling priority.",
"type": "string"
},
"inventory_iteration": {
"required": false,
"enum": [
"use_next",
"out_of_stock",
"global"
],
"description": "What to do when the first selling inventory runs out of stock.",
"type": "string"
},
"expirable_inventories": {
"required": false,
"enum": [
"yes",
"no",
"global"
],
"description": "Set the inventories as 'Out of Stock' when reaching their BBE dates.",
"type": "string"
},
"price_per_inventory": {
"required": false,
"enum": [
"yes",
"no",
"global"
],
"description": "Allow distinct inventories to have distinct prices.",
"type": "string"
}
}
}
]
},
"/wc/v3/products/(?P<product_id>[\\d]+)/variations/(?P<id>[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"product_id": {
"required": false,
"description": "Unique identifier for the variable product.",
"type": "integer"
},
"id": {
"required": false,
"description": "Unique identifier for the variation.",
"type": "integer"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"product_id": {
"required": false,
"description": "Unique identifier for the variable product.",
"type": "integer"
},
"id": {
"required": false,
"description": "Unique identifier for the variation.",
"type": "integer"
},
"description": {
"required": false,
"description": "Variation description.",
"type": "string"
},
"sku": {
"required": false,
"description": "Unique identifier.",
"type": "string"
},
"regular_price": {
"required": false,
"description": "Variation regular price.",
"type": "string"
},
"sale_price": {
"required": false,
"description": "Variation sale price.",
"type": "string"
},
"date_on_sale_from": {
"required": false,
"description": "Start date of sale price, in the site's timezone.",
"type": "date-time"
},
"date_on_sale_from_gmt": {
"required": false,
"description": "Start date of sale price, as GMT.",
"type": "date-time"
},
"date_on_sale_to": {
"required": false,
"description": "End date of sale price, in the site's timezone.",
"type": "date-time"
},
"date_on_sale_to_gmt": {
"required": false,
"description": "End date of sale price, in the site's timezone.",
"type": "date-time"
},
"status": {
"required": false,
"enum": [
"draft",
"pending",
"private",
"publish"
],
"description": "Variation status.",
"type": "string"
},
"virtual": {
"required": false,
"description": "If the variation is virtual.",
"type": "boolean"
},
"downloadable": {
"required": false,
"description": "If the variation is downloadable.",
"type": "boolean"
},
"downloads": {
"required": false,
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"download_limit": {
"required": false,
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer"
},
"download_expiry": {
"required": false,
"description": "Number of days until access to downloadable files expires.",
"type": "integer"
},
"tax_status": {
"required": false,
"enum": [
"taxable",
"shipping",
"none"
],
"description": "Tax status.",
"type": "string"
},
"tax_class": {
"required": false,
"description": "Tax class.",
"type": "string"
},
"manage_stock": {
"required": false,
"description": "Stock management at variation level.",
"type": "boolean"
},
"stock_quantity": {
"required": false,
"description": "Stock quantity.",
"type": "integer"
},
"stock_status": {
"required": false,
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"description": "Controls the stock status of the product.",
"type": "string"
},
"backorders": {
"required": false,
"enum": [
"no",
"notify",
"yes"
],
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string"
},
"weight": {
"required": false,
"description": "Variation weight (lbs).",
"type": "string"
},
"dimensions": {
"required": false,
"description": "Variation dimensions.",
"type": "object"
},
"shipping_class": {
"required": false,
"description": "Shipping class slug.",
"type": "string"
},
"image": {
"required": false,
"description": "Variation image data.",
"type": "object"
},
"attributes": {
"required": false,
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"menu_order": {
"required": false,
"description": "Menu order, used to custom sort products.",
"type": "integer"
},
"meta_data": {
"required": false,
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
},
"purchase_price": {
"required": false,
"description": "Product's purchase price.",
"type": "number"
},
"supplier_id": {
"required": false,
"description": "The ID of the ATUM Supplier that is linked to this product.",
"type": "integer"
},
"supplier_sku": {
"required": false,
"description": "The Supplier's SKU for this product.",
"type": "string"
},
"atum_controlled": {
"required": false,
"description": "Whether this product is being controlled by ATUM.",
"type": "boolean"
},
"out_stock_date": {
"required": false,
"description": "The date when this product run out of stock.",
"type": "date-time"
},
"out_stock_threshold": {
"required": false,
"description": "Out of stock threshold at product level.",
"type": "number"
},
"inheritable": {
"required": false,
"description": "Whether this product may have children.",
"type": "boolean"
},
"inbound_stock": {
"required": false,
"description": "Product's inbound stock.",
"type": "number"
},
"stock_on_hold": {
"required": false,
"description": "Product's stock on hold.",
"type": "number"
},
"sold_today": {
"required": false,
"description": "Units sold today.",
"type": "number"
},
"sales_last_days": {
"required": false,
"description": "Sales the last 14 days.",
"type": "number"
},
"reserved_stock": {
"required": false,
"description": "Stock set as 'reserved_stock' within Inventory Logs.",
"type": "number"
},
"customer_returns": {
"required": false,
"description": "Stock set as 'customer returns' within Inventory Logs.",
"type": "number"
},
"warehouse_damage": {
"required": false,
"description": "Stock set as 'warehouse damage' within Inventory Logs.",
"type": "number"
},
"lost_in_post": {
"required": false,
"description": "Stock set as 'lost in post' within Inventory Logs.",
"type": "number"
},
"other_logs": {
"required": false,
"description": "Stock set as 'other' within Inventory Logs.",
"type": "number"
},
"out_stock_days": {
"required": false,
"description": "The number of days that the product is Out of stock.",
"type": "integer"
},
"lost_sales": {
"required": false,
"description": "Product lost sales.",
"type": "number"
},
"has_location": {
"required": false,
"description": "Whether this product has any ATUM location set.",
"type": "boolean"
},
"update_date": {
"required": false,
"description": "Last date when the ATUM product data was calculated and saved for this product.",
"type": "date-time"
},
"linked_bom": {
"required": false,
"description": "The BOM linked to this product with their quantities.",
"type": "array",
"items": {
"type": "object",
"properties": {
"bom_id": {
"description": "The linked BOM product ID.",
"type": "integer",
"required": true,
"context": [
"view",
"edit"
]
},
"bom_type": {
"description": "The linked BOM product type.",
"type": "string",
"enum": [
"raw_material",
"product_part"
],
"context": [
"view",
"edit"
]
},
"qty": {
"description": "The linked BOM quantity.",
"type": "number",
"context": [
"view",
"edit"
]
},
"delete": {
"description": "Whether to delete the linked BOM from the product.",
"type": "boolean",
"context": [
"edit"
]
}
}
}
},
"sync_purchase_price": {
"required": false,
"description": "Whether to sync the product's purchase price with the BOM's purchase price.",
"type": "boolean"
},
"bom_sellable": {
"required": false,
"description": "If the product is a BOM, indicates whether the product is sellable.",
"type": "boolean"
},
"minimum_threshold": {
"required": false,
"description": "If the product is a BOM, indicates the product's minimum threshold.",
"type": "number"
},
"available_to_purchase": {
"required": false,
"description": "If the product is a BOM, indicates the product's available to purchase amount.",
"type": "number"
},
"selling_priority": {
"required": false,
"description": "If the product is a BOM, indicates the product's selling priority.",
"type": "integer"
},
"calculated_stock": {
"required": false,
"description": "If the BOM stock control is enabled and the product has linked BOM, it indicates the calculated stock quantity.",
"type": "number"
},
"multi_inventory": {
"required": false,
"enum": [
"yes",
"no",
"global"
],
"description": "The Multi Inventory status for this product.",
"type": "string"
},
"inventory_sorting_mode": {
"required": false,
"enum": [
"fifo",
"lifo",
"bbe",
"manual",
"global"
],
"description": "The sorting mode specified for inventory selling priority.",
"type": "string"
},
"inventory_iteration": {
"required": false,
"enum": [
"use_next",
"out_of_stock",
"global"
],
"description": "What to do when the first selling inventory runs out of stock.",
"type": "string"
},
"expirable_inventories": {
"required": false,
"enum": [
"yes",
"no",
"global"
],
"description": "Set the inventories as 'Out of Stock' when reaching their BBE dates.",
"type": "string"
},
"price_per_inventory": {
"required": false,
"enum": [
"yes",
"no",
"global"
],
"description": "Allow distinct inventories to have distinct prices.",
"type": "string"
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"product_id": {
"required": false,
"description": "Unique identifier for the variable product.",
"type": "integer"
},
"id": {
"required": false,
"description": "Unique identifier for the variation.",
"type": "integer"
},
"force": {
"required": false,
"default": false,
"description": "Whether to bypass bin and force deletion.",
"type": "boolean"
}
}
}
]
},
"/wc/v3/products/(?P<product_id>[\\d]+)/variations/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"product_id": {
"required": false,
"description": "Unique identifier for the variable product.",
"type": "integer"
},
"description": {
"required": false,
"description": "Variation description.",
"type": "string"
},
"sku": {
"required": false,
"description": "Unique identifier.",
"type": "string"
},
"regular_price": {
"required": false,
"description": "Variation regular price.",
"type": "string"
},
"sale_price": {
"required": false,
"description": "Variation sale price.",
"type": "string"
},
"date_on_sale_from": {
"required": false,
"description": "Start date of sale price, in the site's timezone.",
"type": "date-time"
},
"date_on_sale_from_gmt": {
"required": false,
"description": "Start date of sale price, as GMT.",
"type": "date-time"
},
"date_on_sale_to": {
"required": false,
"description": "End date of sale price, in the site's timezone.",
"type": "date-time"
},
"date_on_sale_to_gmt": {
"required": false,
"description": "End date of sale price, in the site's timezone.",
"type": "date-time"
},
"status": {
"required": false,
"enum": [
"draft",
"pending",
"private",
"publish"
],
"description": "Variation status.",
"type": "string"
},
"virtual": {
"required": false,
"description": "If the variation is virtual.",
"type": "boolean"
},
"downloadable": {
"required": false,
"description": "If the variation is downloadable.",
"type": "boolean"
},
"downloads": {
"required": false,
"description": "List of downloadable files.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "File ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"name": {
"description": "File name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"file": {
"description": "File URL.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"download_limit": {
"required": false,
"description": "Number of times downloadable files can be downloaded after purchase.",
"type": "integer"
},
"download_expiry": {
"required": false,
"description": "Number of days until access to downloadable files expires.",
"type": "integer"
},
"tax_status": {
"required": false,
"enum": [
"taxable",
"shipping",
"none"
],
"description": "Tax status.",
"type": "string"
},
"tax_class": {
"required": false,
"description": "Tax class.",
"type": "string"
},
"manage_stock": {
"required": false,
"description": "Stock management at variation level.",
"type": "boolean"
},
"stock_quantity": {
"required": false,
"description": "Stock quantity.",
"type": "integer"
},
"stock_status": {
"required": false,
"enum": [
"instock",
"outofstock",
"onbackorder"
],
"description": "Controls the stock status of the product.",
"type": "string"
},
"backorders": {
"required": false,
"enum": [
"no",
"notify",
"yes"
],
"description": "If managing stock, this controls if back-orders are allowed.",
"type": "string"
},
"weight": {
"required": false,
"description": "Variation weight (lbs).",
"type": "string"
},
"dimensions": {
"required": false,
"description": "Variation dimensions.",
"type": "object"
},
"shipping_class": {
"required": false,
"description": "Shipping class slug.",
"type": "string"
},
"image": {
"required": false,
"description": "Variation image data.",
"type": "object"
},
"attributes": {
"required": false,
"description": "List of attributes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Attribute ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Attribute name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"option": {
"description": "Selected attribute term name.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"menu_order": {
"required": false,
"description": "Menu order, used to custom sort products.",
"type": "integer"
},
"meta_data": {
"required": false,
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
},
"purchase_price": {
"required": false,
"description": "Product's purchase price.",
"type": "number"
},
"supplier_id": {
"required": false,
"description": "The ID of the ATUM Supplier that is linked to this product.",
"type": "integer"
},
"supplier_sku": {
"required": false,
"description": "The Supplier's SKU for this product.",
"type": "string"
},
"atum_controlled": {
"required": false,
"description": "Whether this product is being controlled by ATUM.",
"type": "boolean"
},
"out_stock_date": {
"required": false,
"description": "The date when this product run out of stock.",
"type": "date-time"
},
"out_stock_threshold": {
"required": false,
"description": "Out of stock threshold at product level.",
"type": "number"
},
"inheritable": {
"required": false,
"description": "Whether this product may have children.",
"type": "boolean"
},
"inbound_stock": {
"required": false,
"description": "Product's inbound stock.",
"type": "number"
},
"stock_on_hold": {
"required": false,
"description": "Product's stock on hold.",
"type": "number"
},
"sold_today": {
"required": false,
"description": "Units sold today.",
"type": "number"
},
"sales_last_days": {
"required": false,
"description": "Sales the last 14 days.",
"type": "number"
},
"reserved_stock": {
"required": false,
"description": "Stock set as 'reserved_stock' within Inventory Logs.",
"type": "number"
},
"customer_returns": {
"required": false,
"description": "Stock set as 'customer returns' within Inventory Logs.",
"type": "number"
},
"warehouse_damage": {
"required": false,
"description": "Stock set as 'warehouse damage' within Inventory Logs.",
"type": "number"
},
"lost_in_post": {
"required": false,
"description": "Stock set as 'lost in post' within Inventory Logs.",
"type": "number"
},
"other_logs": {
"required": false,
"description": "Stock set as 'other' within Inventory Logs.",
"type": "number"
},
"out_stock_days": {
"required": false,
"description": "The number of days that the product is Out of stock.",
"type": "integer"
},
"lost_sales": {
"required": false,
"description": "Product lost sales.",
"type": "number"
},
"has_location": {
"required": false,
"description": "Whether this product has any ATUM location set.",
"type": "boolean"
},
"update_date": {
"required": false,
"description": "Last date when the ATUM product data was calculated and saved for this product.",
"type": "date-time"
},
"linked_bom": {
"required": false,
"description": "The BOM linked to this product with their quantities.",
"type": "array",
"items": {
"type": "object",
"properties": {
"bom_id": {
"description": "The linked BOM product ID.",
"type": "integer",
"required": true,
"context": [
"view",
"edit"
]
},
"bom_type": {
"description": "The linked BOM product type.",
"type": "string",
"enum": [
"raw_material",
"product_part"
],
"context": [
"view",
"edit"
]
},
"qty": {
"description": "The linked BOM quantity.",
"type": "number",
"context": [
"view",
"edit"
]
},
"delete": {
"description": "Whether to delete the linked BOM from the product.",
"type": "boolean",
"context": [
"edit"
]
}
}
}
},
"sync_purchase_price": {
"required": false,
"description": "Whether to sync the product's purchase price with the BOM's purchase price.",
"type": "boolean"
},
"bom_sellable": {
"required": false,
"description": "If the product is a BOM, indicates whether the product is sellable.",
"type": "boolean"
},
"minimum_threshold": {
"required": false,
"description": "If the product is a BOM, indicates the product's minimum threshold.",
"type": "number"
},
"available_to_purchase": {
"required": false,
"description": "If the product is a BOM, indicates the product's available to purchase amount.",
"type": "number"
},
"selling_priority": {
"required": false,
"description": "If the product is a BOM, indicates the product's selling priority.",
"type": "integer"
},
"calculated_stock": {
"required": false,
"description": "If the BOM stock control is enabled and the product has linked BOM, it indicates the calculated stock quantity.",
"type": "number"
},
"multi_inventory": {
"required": false,
"enum": [
"yes",
"no",
"global"
],
"description": "The Multi Inventory status for this product.",
"type": "string"
},
"inventory_sorting_mode": {
"required": false,
"enum": [
"fifo",
"lifo",
"bbe",
"manual",
"global"
],
"description": "The sorting mode specified for inventory selling priority.",
"type": "string"
},
"inventory_iteration": {
"required": false,
"enum": [
"use_next",
"out_of_stock",
"global"
],
"description": "What to do when the first selling inventory runs out of stock.",
"type": "string"
},
"expirable_inventories": {
"required": false,
"enum": [
"yes",
"no",
"global"
],
"description": "Set the inventories as 'Out of Stock' when reaching their BBE dates.",
"type": "string"
},
"price_per_inventory": {
"required": false,
"enum": [
"yes",
"no",
"global"
],
"description": "Allow distinct inventories to have distinct prices.",
"type": "string"
}
}
}
]
},
"/wc/v3/reports/sales": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
},
"period": {
"required": false,
"enum": [
"week",
"month",
"last_month",
"year"
],
"description": "Report period.",
"type": "string"
},
"date_min": {
"required": false,
"description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.",
"type": "string"
},
"date_max": {
"required": false,
"description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/reports/sales"
}
},
"/wc/v3/reports/top_sellers": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
},
"period": {
"required": false,
"enum": [
"week",
"month",
"last_month",
"year"
],
"description": "Report period.",
"type": "string"
},
"date_min": {
"required": false,
"description": "Return sales for a specific start date; the date needs to be in the YYYY-MM-DD format.",
"type": "string"
},
"date_max": {
"required": false,
"description": "Return sales for a specific end date; the date needs to be in the YYYY-MM-DD format.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/reports/top_sellers"
}
},
"/wc/v3/reports/orders/totals": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/reports/orders/totals"
}
},
"/wc/v3/reports/products/totals": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/reports/products/totals"
}
},
"/wc/v3/reports/customers/totals": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/reports/customers/totals"
}
},
"/wc/v3/reports/coupons/totals": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/reports/coupons/totals"
}
},
"/wc/v3/reports/reviews/totals": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/reports/reviews/totals"
}
},
"/wc/v3/reports": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/reports"
}
},
"/wc/v3/settings": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/settings"
}
},
"/wc/v3/settings/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/settings/batch"
}
},
"/wc/v3/settings/(?P<group_id>[\\w-]+)": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"group": {
"required": false,
"description": "Settings group ID.",
"type": "string"
}
}
}
]
},
"/wc/v3/settings/(?P<group_id>[\\w-]+)/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"group": {
"required": false,
"description": "Settings group ID.",
"type": "string"
},
"value": {
"required": false,
"description": "Setting value.",
"type": "mixed"
}
}
}
]
},
"/wc/v3/settings/(?P<group_id>[\\w-]+)/(?P<id>[\\w-]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"group": {
"required": false,
"description": "Settings group ID.",
"type": "string"
},
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "string"
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"group": {
"required": false,
"description": "Settings group ID.",
"type": "string"
},
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "string"
},
"value": {
"required": false,
"description": "Setting value.",
"type": "mixed"
}
}
}
]
},
"/wc/v3/shipping/zones": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
},
{
"methods": [
"POST"
],
"args": {
"name": {
"required": true,
"description": "Shipping zone name.",
"type": "string"
},
"order": {
"required": false,
"description": "Shipping zone order.",
"type": "integer"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/shipping/zones"
}
},
"/wc/v3/shipping/zones/(?P<id>[\\d-]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"required": false,
"description": "Unique ID for the resource.",
"type": "integer"
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"required": false,
"description": "Unique ID for the resource.",
"type": "integer"
},
"name": {
"required": false,
"description": "Shipping zone name.",
"type": "string"
},
"order": {
"required": false,
"description": "Shipping zone order.",
"type": "integer"
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"required": false,
"description": "Unique ID for the resource.",
"type": "integer"
},
"force": {
"required": false,
"default": false,
"description": "Whether to bypass bin and force deletion.",
"type": "boolean"
}
}
}
]
},
"/wc/v3/shipping/zones/(?P<id>[\\d]+)/locations": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"required": false,
"description": "Unique ID for the resource.",
"type": "integer"
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"required": false,
"description": "Unique ID for the resource.",
"type": "integer"
},
"code": {
"required": false,
"description": "Shipping zone location code.",
"type": "string"
},
"type": {
"required": false,
"enum": [
"postcode",
"state",
"country",
"continent"
],
"description": "Shipping zone location type.",
"type": "string"
}
}
}
]
},
"/wc/v3/shipping/zones/(?P<zone_id>[\\d]+)/methods": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"zone_id": {
"required": false,
"description": "Unique ID for the zone.",
"type": "integer"
}
}
},
{
"methods": [
"POST"
],
"args": {
"zone_id": {
"required": false,
"description": "Unique ID for the zone.",
"type": "integer"
},
"order": {
"required": false,
"description": "Shipping method sort order.",
"type": "integer"
},
"enabled": {
"required": false,
"description": "Shipping method enabled status.",
"type": "boolean"
},
"settings": {
"required": false,
"description": "Shipping method settings.",
"type": "object"
},
"method_id": {
"required": true,
"description": "Shipping method ID."
}
}
}
]
},
"/wc/v3/shipping/zones/(?P<zone_id>[\\d]+)/methods/(?P<instance_id>[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"zone_id": {
"required": false,
"description": "Unique ID for the zone.",
"type": "integer"
},
"instance_id": {
"required": false,
"description": "Unique ID for the instance.",
"type": "integer"
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"zone_id": {
"required": false,
"description": "Unique ID for the zone.",
"type": "integer"
},
"instance_id": {
"required": false,
"description": "Unique ID for the instance.",
"type": "integer"
},
"order": {
"required": false,
"description": "Shipping method sort order.",
"type": "integer"
},
"enabled": {
"required": false,
"description": "Shipping method enabled status.",
"type": "boolean"
},
"settings": {
"required": false,
"description": "Shipping method settings.",
"type": "object"
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"zone_id": {
"required": false,
"description": "Unique ID for the zone.",
"type": "integer"
},
"instance_id": {
"required": false,
"description": "Unique ID for the instance.",
"type": "integer"
},
"force": {
"required": false,
"default": false,
"description": "Whether to bypass bin and force deletion.",
"type": "boolean"
}
}
}
]
},
"/wc/v3/taxes/classes": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"required": true,
"description": "Tax class name.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/taxes/classes"
}
},
"/wc/v3/taxes/classes/(?P<slug>\\w[\\w\\s\\-]*)": {
"namespace": "wc/v3",
"methods": [
"DELETE"
],
"endpoints": [
{
"methods": [
"DELETE"
],
"args": {
"slug": {
"required": false,
"description": "Unique slug for the resource.",
"type": "string"
},
"force": {
"required": false,
"default": false,
"description": "Required to be true, as resource does not support binning.",
"type": "boolean"
}
}
}
]
},
"/wc/v3/taxes": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
},
"page": {
"required": false,
"default": 1,
"description": "Current page of the collection.",
"type": "integer"
},
"per_page": {
"required": false,
"default": 10,
"description": "Maximum number of items to be returned in result set.",
"type": "integer"
},
"offset": {
"required": false,
"description": "Offset the result set by a specific number of items.",
"type": "integer"
},
"order": {
"required": false,
"default": "asc",
"enum": [
"asc",
"desc"
],
"description": "Order sort attribute ascending or descending.",
"type": "string"
},
"orderby": {
"required": false,
"default": "order",
"enum": [
"id",
"order"
],
"description": "Sort collection by object attribute.",
"type": "string"
},
"class": {
"required": false,
"enum": [
"standard",
"reduced-rate",
"zero-rate"
],
"description": "Sort by tax class.",
"type": "string"
}
}
},
{
"methods": [
"POST"
],
"args": {
"country": {
"required": false,
"description": "Country ISO 3166 code.",
"type": "string"
},
"state": {
"required": false,
"description": "State code.",
"type": "string"
},
"postcode": {
"required": false,
"description": "Postcode / ZIP.",
"type": "string"
},
"city": {
"required": false,
"description": "City name.",
"type": "string"
},
"rate": {
"required": false,
"description": "Tax rate.",
"type": "string"
},
"name": {
"required": false,
"description": "Tax rate name.",
"type": "string"
},
"priority": {
"required": false,
"default": 1,
"description": "Tax priority.",
"type": "integer"
},
"compound": {
"required": false,
"default": false,
"description": "Whether or not this is a compound rate.",
"type": "boolean"
},
"shipping": {
"required": false,
"default": true,
"description": "Whether or not this tax rate also gets applied to shipping.",
"type": "boolean"
},
"order": {
"required": false,
"description": "Indicates the order that will appear in queries.",
"type": "integer"
},
"class": {
"required": false,
"default": "standard",
"enum": [
"standard",
"reduced-rate",
"zero-rate"
],
"description": "Tax class.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/taxes"
}
},
"/wc/v3/taxes/(?P<id>[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"country": {
"required": false,
"description": "Country ISO 3166 code.",
"type": "string"
},
"state": {
"required": false,
"description": "State code.",
"type": "string"
},
"postcode": {
"required": false,
"description": "Postcode / ZIP.",
"type": "string"
},
"city": {
"required": false,
"description": "City name.",
"type": "string"
},
"rate": {
"required": false,
"description": "Tax rate.",
"type": "string"
},
"name": {
"required": false,
"description": "Tax rate name.",
"type": "string"
},
"priority": {
"required": false,
"description": "Tax priority.",
"type": "integer"
},
"compound": {
"required": false,
"description": "Whether or not this is a compound rate.",
"type": "boolean"
},
"shipping": {
"required": false,
"description": "Whether or not this tax rate also gets applied to shipping.",
"type": "boolean"
},
"order": {
"required": false,
"description": "Indicates the order that will appear in queries.",
"type": "integer"
},
"class": {
"required": false,
"enum": [
"standard",
"reduced-rate",
"zero-rate"
],
"description": "Tax class.",
"type": "string"
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"force": {
"required": false,
"default": false,
"description": "Required to be true, as resource does not support binning.",
"type": "boolean"
}
}
}
]
},
"/wc/v3/taxes/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"country": {
"required": false,
"description": "Country ISO 3166 code.",
"type": "string"
},
"state": {
"required": false,
"description": "State code.",
"type": "string"
},
"postcode": {
"required": false,
"description": "Postcode / ZIP.",
"type": "string"
},
"city": {
"required": false,
"description": "City name.",
"type": "string"
},
"rate": {
"required": false,
"description": "Tax rate.",
"type": "string"
},
"name": {
"required": false,
"description": "Tax rate name.",
"type": "string"
},
"priority": {
"required": false,
"description": "Tax priority.",
"type": "integer"
},
"compound": {
"required": false,
"description": "Whether or not this is a compound rate.",
"type": "boolean"
},
"shipping": {
"required": false,
"description": "Whether or not this tax rate also gets applied to shipping.",
"type": "boolean"
},
"order": {
"required": false,
"description": "Indicates the order that will appear in queries.",
"type": "integer"
},
"class": {
"required": false,
"enum": [
"standard",
"reduced-rate",
"zero-rate"
],
"description": "Tax class.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/taxes/batch"
}
},
"/wc/v3/webhooks": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
},
"page": {
"required": false,
"default": 1,
"description": "Current page of the collection.",
"type": "integer"
},
"per_page": {
"required": false,
"default": 10,
"description": "Maximum number of items to be returned in result set.",
"type": "integer"
},
"search": {
"required": false,
"description": "Limit results to those matching a string.",
"type": "string"
},
"after": {
"required": false,
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string"
},
"before": {
"required": false,
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string"
},
"exclude": {
"required": false,
"default": [],
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"include": {
"required": false,
"default": [],
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
}
},
"offset": {
"required": false,
"description": "Offset the result set by a specific number of items.",
"type": "integer"
},
"order": {
"required": false,
"default": "desc",
"enum": [
"asc",
"desc"
],
"description": "Order sort attribute ascending or descending.",
"type": "string"
},
"orderby": {
"required": false,
"default": "date",
"enum": [
"date",
"id",
"title"
],
"description": "Sort collection by object attribute.",
"type": "string"
},
"status": {
"required": false,
"default": "all",
"enum": [
"all",
"active",
"paused",
"disabled"
],
"description": "Limit result set to webhooks assigned a specific status.",
"type": "string"
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"required": false,
"description": "A friendly name for the webhook.",
"type": "string"
},
"status": {
"required": false,
"default": "active",
"enum": [
"active",
"paused",
"disabled"
],
"description": "Webhook status.",
"type": "string"
},
"topic": {
"required": true,
"description": "Webhook topic.",
"type": "string"
},
"secret": {
"required": false,
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
"type": "string"
},
"delivery_url": {
"required": true,
"description": "Webhook delivery URL.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/webhooks"
}
},
"/wc/v3/webhooks/(?P<id>[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"name": {
"required": false,
"description": "A friendly name for the webhook.",
"type": "string"
},
"status": {
"required": false,
"enum": [
"active",
"paused",
"disabled"
],
"description": "Webhook status.",
"type": "string"
},
"topic": {
"required": false,
"description": "Webhook topic.",
"type": "string"
},
"secret": {
"required": false,
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
"type": "string"
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"force": {
"required": false,
"default": false,
"description": "Required to be true, as resource does not support binning.",
"type": "boolean"
}
}
}
]
},
"/wc/v3/webhooks/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"required": false,
"description": "A friendly name for the webhook.",
"type": "string"
},
"status": {
"required": false,
"enum": [
"active",
"paused",
"disabled"
],
"description": "Webhook status.",
"type": "string"
},
"topic": {
"required": false,
"description": "Webhook topic.",
"type": "string"
},
"secret": {
"required": false,
"description": "Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default to a MD5 hash from the current user's ID|username if not provided.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/webhooks/batch"
}
},
"/wc/v3/system_status": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/system_status"
}
},
"/wc/v3/system_status/tools": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/system_status/tools"
}
},
"/wc/v3/system_status/tools/(?P<id>[\\w-]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "string"
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"required": false,
"description": "A unique identifier for the tool.",
"type": "string"
},
"name": {
"required": false,
"description": "Tool name.",
"type": "string"
},
"action": {
"required": false,
"description": "What running the tool will do.",
"type": "string"
},
"description": {
"required": false,
"description": "Tool description.",
"type": "string"
},
"success": {
"required": false,
"description": "Did the tool run successfully?",
"type": "boolean"
},
"message": {
"required": false,
"description": "Tool return message.",
"type": "string"
}
}
}
]
},
"/wc/v3/shipping_methods": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/shipping_methods"
}
},
"/wc/v3/shipping_methods/(?P<id>[\\w-]+)": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "string"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
}
]
},
"/wc/v3/payment_gateways": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/payment_gateways"
}
},
"/wc/v3/payment_gateways/(?P<id>[\\w-]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "string"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "string"
},
"title": {
"required": false,
"description": "Payment gateway title on checkout.",
"type": "string"
},
"description": {
"required": false,
"description": "Payment gateway description on checkout.",
"type": "string"
},
"order": {
"required": false,
"description": "Payment gateway sort order.",
"type": "integer"
},
"enabled": {
"required": false,
"description": "Payment gateway enabled status.",
"type": "boolean"
},
"settings": {
"required": false,
"description": "Payment gateway settings.",
"type": "object"
}
}
}
]
},
"/wc/v3/data": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/data"
}
},
"/wc/v3/data/continents": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/data/continents"
}
},
"/wc/v3/data/continents/(?P<location>[\\w-]+)": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"continent": {
"required": false,
"description": "2 character continent code.",
"type": "string"
}
}
}
]
},
"/wc/v3/data/countries": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/data/countries"
}
},
"/wc/v3/data/countries/(?P<location>[\\w-]+)": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"location": {
"required": false,
"description": "ISO3166 alpha-2 country code.",
"type": "string"
}
}
}
]
},
"/wc/v3/data/currencies": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/data/currencies"
}
},
"/wc/v3/data/currencies/current": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/data/currencies/current"
}
},
"/wc/v3/data/currencies/(?P<currency>[\\w-]{3})": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"location": {
"required": false,
"description": "ISO4217 currency code.",
"type": "string"
}
}
}
]
},
"/wc/v3/atum/suppliers": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
},
"page": {
"required": false,
"default": 1,
"description": "Current page of the collection.",
"type": "integer"
},
"per_page": {
"required": false,
"default": 10,
"description": "Maximum number of items to be returned in result set.",
"type": "integer"
},
"search": {
"required": false,
"description": "Limit results to those matching a string.",
"type": "string"
},
"after": {
"required": false,
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string"
},
"before": {
"required": false,
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string"
},
"exclude": {
"required": false,
"default": [],
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"include": {
"required": false,
"default": [],
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
}
},
"offset": {
"required": false,
"description": "Offset the result set by a specific number of items.",
"type": "integer"
},
"order": {
"required": false,
"default": "desc",
"enum": [
"asc",
"desc"
],
"description": "Order sort attribute ascending or descending.",
"type": "string"
},
"orderby": {
"required": false,
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug"
],
"description": "Sort collection by object attribute.",
"type": "string"
},
"slug": {
"required": false,
"description": "Limit result set to suppliers with a specific slug.",
"type": "string"
},
"status": {
"required": false,
"default": "any",
"enum": [
"draft",
"pending",
"private",
"publish",
"any"
],
"description": "Limit result set to suppliers assigned a specific status.",
"type": "string"
},
"currency": {
"required": false,
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYR",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"IRT",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PRB",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
],
"description": "Limit result set to suppliers using the specified currency code.",
"type": "string"
},
"country": {
"required": false,
"enum": [
"AX",
"AF",
"AL",
"DZ",
"AS",
"AD",
"AO",
"AI",
"AQ",
"AG",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BY",
"PW",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BO",
"BQ",
"BA",
"BW",
"BV",
"BR",
"IO",
"BN",
"BG",
"BF",
"BI",
"KH",
"CM",
"CA",
"CV",
"KY",
"CF",
"TD",
"CL",
"CN",
"CX",
"CC",
"CO",
"KM",
"CG",
"CD",
"CK",
"CR",
"HR",
"CU",
"CW",
"CY",
"CZ",
"DK",
"DJ",
"DM",
"DO",
"EC",
"EG",
"SV",
"GQ",
"ER",
"EE",
"ET",
"FK",
"FO",
"FJ",
"FI",
"FR",
"GF",
"PF",
"TF",
"GA",
"GM",
"GE",
"DE",
"GH",
"GI",
"GR",
"GL",
"GD",
"GP",
"GU",
"GT",
"GG",
"GN",
"GW",
"GY",
"HT",
"HM",
"HN",
"HK",
"HU",
"IS",
"IN",
"ID",
"IR",
"IQ",
"IE",
"IM",
"IL",
"IT",
"CI",
"JM",
"JP",
"JE",
"JO",
"KZ",
"KE",
"KI",
"KW",
"KG",
"LA",
"LV",
"LB",
"LS",
"LR",
"LY",
"LI",
"LT",
"LU",
"MO",
"MG",
"MW",
"MY",
"MV",
"ML",
"MT",
"MH",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"ME",
"MS",
"MA",
"MZ",
"MM",
"NA",
"NR",
"NP",
"NL",
"NC",
"NZ",
"NI",
"NE",
"NG",
"NU",
"NF",
"KP",
"MK",
"MP",
"NO",
"OM",
"PK",
"PS",
"PA",
"PG",
"PY",
"PE",
"PH",
"PN",
"PL",
"PT",
"PR",
"QA",
"RE",
"RO",
"RU",
"RW",
"ST",
"BL",
"SH",
"KN",
"LC",
"SX",
"MF",
"PM",
"VC",
"WS",
"SM",
"SA",
"SN",
"RS",
"SC",
"SL",
"SG",
"SK",
"SI",
"SB",
"SO",
"ZA",
"GS",
"KR",
"SS",
"ES",
"LK",
"SD",
"SR",
"SJ",
"SZ",
"SE",
"CH",
"SY",
"TW",
"TJ",
"TZ",
"TH",
"TL",
"TG",
"TK",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"AE",
"GB",
"US",
"UM",
"UY",
"UZ",
"VU",
"VA",
"VE",
"VN",
"VG",
"VI",
"WF",
"EH",
"YE",
"ZM",
"ZW"
],
"description": "Limit result set to suppliers from the specified country code.",
"type": "string"
},
"assigned_to": {
"required": false,
"description": "Limit result set to suppliers assigned to the specified user ID.",
"type": "integer"
},
"product": {
"required": false,
"description": "Limit result set to suppliers assigned to the specific product ID.",
"type": "integer"
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"required": false,
"description": "Supplier name.",
"type": "string"
},
"slug": {
"required": false,
"description": "Supplier slug.",
"type": "string"
},
"date_created": {
"required": false,
"description": "The date the supplier was created, in the site's timezone.",
"type": "date-time"
},
"date_created_gmt": {
"required": false,
"description": "The date the supplier was created, as GMT.",
"type": "date-time"
},
"status": {
"required": false,
"default": "publish",
"enum": [
"draft",
"pending",
"private",
"publish"
],
"description": "Supplier status (post status).",
"type": "string"
},
"code": {
"required": false,
"description": "Supplier code.",
"type": "string"
},
"tax_number": {
"required": false,
"description": "Supplier tax/VAT number.",
"type": "string"
},
"phone": {
"required": false,
"description": "Supplier phone number.",
"type": "string"
},
"fax": {
"required": false,
"description": "Supplier fax number.",
"type": "string"
},
"website": {
"required": false,
"description": "Supplier website.",
"type": "string"
},
"ordering_url": {
"required": false,
"description": "Supplier ordering URL.",
"type": "string"
},
"general_email": {
"required": false,
"description": "Supplier general email.",
"type": "string"
},
"ordering_email": {
"required": false,
"description": "Supplier ordering email.",
"type": "string"
},
"description": {
"required": false,
"description": "Supplier description.",
"type": "string"
},
"currency": {
"required": false,
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYR",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"IRT",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PRB",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
],
"description": "Supplier currency.",
"type": "string"
},
"address": {
"required": false,
"description": "Supplier address.",
"type": "string"
},
"city": {
"required": false,
"description": "Supplier city.",
"type": "string"
},
"country": {
"required": false,
"enum": [
"AX",
"AF",
"AL",
"DZ",
"AS",
"AD",
"AO",
"AI",
"AQ",
"AG",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BY",
"PW",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BO",
"BQ",
"BA",
"BW",
"BV",
"BR",
"IO",
"BN",
"BG",
"BF",
"BI",
"KH",
"CM",
"CA",
"CV",
"KY",
"CF",
"TD",
"CL",
"CN",
"CX",
"CC",
"CO",
"KM",
"CG",
"CD",
"CK",
"CR",
"HR",
"CU",
"CW",
"CY",
"CZ",
"DK",
"DJ",
"DM",
"DO",
"EC",
"EG",
"SV",
"GQ",
"ER",
"EE",
"ET",
"FK",
"FO",
"FJ",
"FI",
"FR",
"GF",
"PF",
"TF",
"GA",
"GM",
"GE",
"DE",
"GH",
"GI",
"GR",
"GL",
"GD",
"GP",
"GU",
"GT",
"GG",
"GN",
"GW",
"GY",
"HT",
"HM",
"HN",
"HK",
"HU",
"IS",
"IN",
"ID",
"IR",
"IQ",
"IE",
"IM",
"IL",
"IT",
"CI",
"JM",
"JP",
"JE",
"JO",
"KZ",
"KE",
"KI",
"KW",
"KG",
"LA",
"LV",
"LB",
"LS",
"LR",
"LY",
"LI",
"LT",
"LU",
"MO",
"MG",
"MW",
"MY",
"MV",
"ML",
"MT",
"MH",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"ME",
"MS",
"MA",
"MZ",
"MM",
"NA",
"NR",
"NP",
"NL",
"NC",
"NZ",
"NI",
"NE",
"NG",
"NU",
"NF",
"KP",
"MK",
"MP",
"NO",
"OM",
"PK",
"PS",
"PA",
"PG",
"PY",
"PE",
"PH",
"PN",
"PL",
"PT",
"PR",
"QA",
"RE",
"RO",
"RU",
"RW",
"ST",
"BL",
"SH",
"KN",
"LC",
"SX",
"MF",
"PM",
"VC",
"WS",
"SM",
"SA",
"SN",
"RS",
"SC",
"SL",
"SG",
"SK",
"SI",
"SB",
"SO",
"ZA",
"GS",
"KR",
"SS",
"ES",
"LK",
"SD",
"SR",
"SJ",
"SZ",
"SE",
"CH",
"SY",
"TW",
"TJ",
"TZ",
"TH",
"TL",
"TG",
"TK",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"AE",
"GB",
"US",
"UM",
"UY",
"UZ",
"VU",
"VA",
"VE",
"VN",
"VG",
"VI",
"WF",
"EH",
"YE",
"ZM",
"ZW"
],
"description": "Supplier city.",
"type": "string"
},
"state": {
"required": false,
"description": "Supplier state.",
"type": "string"
},
"zip_code": {
"required": false,
"description": "Supplier ZIP code.",
"type": "string"
},
"assigned_to": {
"required": false,
"description": "The user ID that this supplier is assigned to.",
"type": "integer"
},
"location": {
"required": false,
"description": "The location used in Purchase Orders assigned to this supplier.",
"type": "string"
},
"image": {
"required": false,
"description": "Supplier featured image.",
"type": "object",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": "date-time",
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT",
"type": "date-time",
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was modified, in the site's timezone.",
"type": "date-time",
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was modified, as GMT.",
"type": "date-time",
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"meta_data": {
"required": false,
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/atum/suppliers"
}
},
"/wc/v3/atum/suppliers/(?P<id>[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"name": {
"required": false,
"description": "Supplier name.",
"type": "string"
},
"slug": {
"required": false,
"description": "Supplier slug.",
"type": "string"
},
"date_created": {
"required": false,
"description": "The date the supplier was created, in the site's timezone.",
"type": "date-time"
},
"date_created_gmt": {
"required": false,
"description": "The date the supplier was created, as GMT.",
"type": "date-time"
},
"status": {
"required": false,
"enum": [
"draft",
"pending",
"private",
"publish"
],
"description": "Supplier status (post status).",
"type": "string"
},
"code": {
"required": false,
"description": "Supplier code.",
"type": "string"
},
"tax_number": {
"required": false,
"description": "Supplier tax/VAT number.",
"type": "string"
},
"phone": {
"required": false,
"description": "Supplier phone number.",
"type": "string"
},
"fax": {
"required": false,
"description": "Supplier fax number.",
"type": "string"
},
"website": {
"required": false,
"description": "Supplier website.",
"type": "string"
},
"ordering_url": {
"required": false,
"description": "Supplier ordering URL.",
"type": "string"
},
"general_email": {
"required": false,
"description": "Supplier general email.",
"type": "string"
},
"ordering_email": {
"required": false,
"description": "Supplier ordering email.",
"type": "string"
},
"description": {
"required": false,
"description": "Supplier description.",
"type": "string"
},
"currency": {
"required": false,
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYR",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"IRT",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PRB",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
],
"description": "Supplier currency.",
"type": "string"
},
"address": {
"required": false,
"description": "Supplier address.",
"type": "string"
},
"city": {
"required": false,
"description": "Supplier city.",
"type": "string"
},
"country": {
"required": false,
"enum": [
"AX",
"AF",
"AL",
"DZ",
"AS",
"AD",
"AO",
"AI",
"AQ",
"AG",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BY",
"PW",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BO",
"BQ",
"BA",
"BW",
"BV",
"BR",
"IO",
"BN",
"BG",
"BF",
"BI",
"KH",
"CM",
"CA",
"CV",
"KY",
"CF",
"TD",
"CL",
"CN",
"CX",
"CC",
"CO",
"KM",
"CG",
"CD",
"CK",
"CR",
"HR",
"CU",
"CW",
"CY",
"CZ",
"DK",
"DJ",
"DM",
"DO",
"EC",
"EG",
"SV",
"GQ",
"ER",
"EE",
"ET",
"FK",
"FO",
"FJ",
"FI",
"FR",
"GF",
"PF",
"TF",
"GA",
"GM",
"GE",
"DE",
"GH",
"GI",
"GR",
"GL",
"GD",
"GP",
"GU",
"GT",
"GG",
"GN",
"GW",
"GY",
"HT",
"HM",
"HN",
"HK",
"HU",
"IS",
"IN",
"ID",
"IR",
"IQ",
"IE",
"IM",
"IL",
"IT",
"CI",
"JM",
"JP",
"JE",
"JO",
"KZ",
"KE",
"KI",
"KW",
"KG",
"LA",
"LV",
"LB",
"LS",
"LR",
"LY",
"LI",
"LT",
"LU",
"MO",
"MG",
"MW",
"MY",
"MV",
"ML",
"MT",
"MH",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"ME",
"MS",
"MA",
"MZ",
"MM",
"NA",
"NR",
"NP",
"NL",
"NC",
"NZ",
"NI",
"NE",
"NG",
"NU",
"NF",
"KP",
"MK",
"MP",
"NO",
"OM",
"PK",
"PS",
"PA",
"PG",
"PY",
"PE",
"PH",
"PN",
"PL",
"PT",
"PR",
"QA",
"RE",
"RO",
"RU",
"RW",
"ST",
"BL",
"SH",
"KN",
"LC",
"SX",
"MF",
"PM",
"VC",
"WS",
"SM",
"SA",
"SN",
"RS",
"SC",
"SL",
"SG",
"SK",
"SI",
"SB",
"SO",
"ZA",
"GS",
"KR",
"SS",
"ES",
"LK",
"SD",
"SR",
"SJ",
"SZ",
"SE",
"CH",
"SY",
"TW",
"TJ",
"TZ",
"TH",
"TL",
"TG",
"TK",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"AE",
"GB",
"US",
"UM",
"UY",
"UZ",
"VU",
"VA",
"VE",
"VN",
"VG",
"VI",
"WF",
"EH",
"YE",
"ZM",
"ZW"
],
"description": "Supplier city.",
"type": "string"
},
"state": {
"required": false,
"description": "Supplier state.",
"type": "string"
},
"zip_code": {
"required": false,
"description": "Supplier ZIP code.",
"type": "string"
},
"assigned_to": {
"required": false,
"description": "The user ID that this supplier is assigned to.",
"type": "integer"
},
"location": {
"required": false,
"description": "The location used in Purchase Orders assigned to this supplier.",
"type": "string"
},
"image": {
"required": false,
"description": "Supplier featured image.",
"type": "object",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": "date-time",
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT",
"type": "date-time",
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was modified, in the site's timezone.",
"type": "date-time",
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was modified, as GMT.",
"type": "date-time",
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"meta_data": {
"required": false,
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"force": {
"required": false,
"default": false,
"description": "Whether to bypass trash and force deletion.",
"type": "boolean"
}
}
}
]
},
"/wc/v3/atum/suppliers/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"required": false,
"description": "Supplier name.",
"type": "string"
},
"slug": {
"required": false,
"description": "Supplier slug.",
"type": "string"
},
"date_created": {
"required": false,
"description": "The date the supplier was created, in the site's timezone.",
"type": "date-time"
},
"date_created_gmt": {
"required": false,
"description": "The date the supplier was created, as GMT.",
"type": "date-time"
},
"status": {
"required": false,
"enum": [
"draft",
"pending",
"private",
"publish"
],
"description": "Supplier status (post status).",
"type": "string"
},
"code": {
"required": false,
"description": "Supplier code.",
"type": "string"
},
"tax_number": {
"required": false,
"description": "Supplier tax/VAT number.",
"type": "string"
},
"phone": {
"required": false,
"description": "Supplier phone number.",
"type": "string"
},
"fax": {
"required": false,
"description": "Supplier fax number.",
"type": "string"
},
"website": {
"required": false,
"description": "Supplier website.",
"type": "string"
},
"ordering_url": {
"required": false,
"description": "Supplier ordering URL.",
"type": "string"
},
"general_email": {
"required": false,
"description": "Supplier general email.",
"type": "string"
},
"ordering_email": {
"required": false,
"description": "Supplier ordering email.",
"type": "string"
},
"description": {
"required": false,
"description": "Supplier description.",
"type": "string"
},
"currency": {
"required": false,
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYR",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"IRT",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PRB",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
],
"description": "Supplier currency.",
"type": "string"
},
"address": {
"required": false,
"description": "Supplier address.",
"type": "string"
},
"city": {
"required": false,
"description": "Supplier city.",
"type": "string"
},
"country": {
"required": false,
"enum": [
"AX",
"AF",
"AL",
"DZ",
"AS",
"AD",
"AO",
"AI",
"AQ",
"AG",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BY",
"PW",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BO",
"BQ",
"BA",
"BW",
"BV",
"BR",
"IO",
"BN",
"BG",
"BF",
"BI",
"KH",
"CM",
"CA",
"CV",
"KY",
"CF",
"TD",
"CL",
"CN",
"CX",
"CC",
"CO",
"KM",
"CG",
"CD",
"CK",
"CR",
"HR",
"CU",
"CW",
"CY",
"CZ",
"DK",
"DJ",
"DM",
"DO",
"EC",
"EG",
"SV",
"GQ",
"ER",
"EE",
"ET",
"FK",
"FO",
"FJ",
"FI",
"FR",
"GF",
"PF",
"TF",
"GA",
"GM",
"GE",
"DE",
"GH",
"GI",
"GR",
"GL",
"GD",
"GP",
"GU",
"GT",
"GG",
"GN",
"GW",
"GY",
"HT",
"HM",
"HN",
"HK",
"HU",
"IS",
"IN",
"ID",
"IR",
"IQ",
"IE",
"IM",
"IL",
"IT",
"CI",
"JM",
"JP",
"JE",
"JO",
"KZ",
"KE",
"KI",
"KW",
"KG",
"LA",
"LV",
"LB",
"LS",
"LR",
"LY",
"LI",
"LT",
"LU",
"MO",
"MG",
"MW",
"MY",
"MV",
"ML",
"MT",
"MH",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"ME",
"MS",
"MA",
"MZ",
"MM",
"NA",
"NR",
"NP",
"NL",
"NC",
"NZ",
"NI",
"NE",
"NG",
"NU",
"NF",
"KP",
"MK",
"MP",
"NO",
"OM",
"PK",
"PS",
"PA",
"PG",
"PY",
"PE",
"PH",
"PN",
"PL",
"PT",
"PR",
"QA",
"RE",
"RO",
"RU",
"RW",
"ST",
"BL",
"SH",
"KN",
"LC",
"SX",
"MF",
"PM",
"VC",
"WS",
"SM",
"SA",
"SN",
"RS",
"SC",
"SL",
"SG",
"SK",
"SI",
"SB",
"SO",
"ZA",
"GS",
"KR",
"SS",
"ES",
"LK",
"SD",
"SR",
"SJ",
"SZ",
"SE",
"CH",
"SY",
"TW",
"TJ",
"TZ",
"TH",
"TL",
"TG",
"TK",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"AE",
"GB",
"US",
"UM",
"UY",
"UZ",
"VU",
"VA",
"VE",
"VN",
"VG",
"VI",
"WF",
"EH",
"YE",
"ZM",
"ZW"
],
"description": "Supplier city.",
"type": "string"
},
"state": {
"required": false,
"description": "Supplier state.",
"type": "string"
},
"zip_code": {
"required": false,
"description": "Supplier ZIP code.",
"type": "string"
},
"assigned_to": {
"required": false,
"description": "The user ID that this supplier is assigned to.",
"type": "integer"
},
"location": {
"required": false,
"description": "The location used in Purchase Orders assigned to this supplier.",
"type": "string"
},
"image": {
"required": false,
"description": "Supplier featured image.",
"type": "object",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Image ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"date_created": {
"description": "The date the image was created, in the site's timezone.",
"type": "date-time",
"context": [
"view",
"edit"
],
"readonly": true
},
"date_created_gmt": {
"description": "The date the image was created, as GMT",
"type": "date-time",
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified": {
"description": "The date the image was modified, in the site's timezone.",
"type": "date-time",
"context": [
"view",
"edit"
],
"readonly": true
},
"date_modified_gmt": {
"description": "The date the image was modified, as GMT.",
"type": "date-time",
"context": [
"view",
"edit"
],
"readonly": true
},
"src": {
"description": "Image URL.",
"type": "string",
"format": "uri",
"context": [
"view",
"edit"
]
},
"name": {
"description": "Image name.",
"type": "string",
"context": [
"view",
"edit"
]
},
"alt": {
"description": "Image alternative text.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"meta_data": {
"required": false,
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/atum/suppliers/batch"
}
},
"/wc/v3/atum/purchase-orders": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
},
"page": {
"required": false,
"default": 1,
"description": "Current page of the collection.",
"type": "integer"
},
"per_page": {
"required": false,
"default": 10,
"description": "Maximum number of items to be returned in result set.",
"type": "integer"
},
"search": {
"required": false,
"description": "Limit results to those matching a string.",
"type": "string"
},
"after": {
"required": false,
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string"
},
"before": {
"required": false,
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string"
},
"exclude": {
"required": false,
"default": [],
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"include": {
"required": false,
"default": [],
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
}
},
"offset": {
"required": false,
"description": "Offset the result set by a specific number of items.",
"type": "integer"
},
"order": {
"required": false,
"default": "desc",
"enum": [
"asc",
"desc"
],
"description": "Order sort attribute ascending or descending.",
"type": "string"
},
"orderby": {
"required": false,
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug"
],
"description": "Sort collection by object attribute.",
"type": "string"
},
"parent": {
"required": false,
"default": [],
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"parent_exclude": {
"required": false,
"default": [],
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
}
},
"status": {
"required": false,
"default": "any",
"description": "Limit result set to ATUM orders which have specific statuses.",
"type": "array",
"items": {
"type": "string",
"enum": [
"any",
"trash",
"atum_pending",
"atum_ordered",
"atum_onthewayin",
"atum_receiving",
"atum_received"
]
}
},
"product": {
"required": false,
"description": "Limit result set to orders assigned a specific product.",
"type": "integer"
},
"dp": {
"required": false,
"default": 2,
"description": "Number of decimal points to use in each resource.",
"type": "integer"
},
"date_expected": {
"required": false,
"description": "Limit result set to purchase orders expected at location on a given ISO8601 compliant date.",
"type": "string"
},
"supplier": {
"required": false,
"description": "Limit result set to purchase orders linked to the specified supplier ID.",
"type": "integer"
},
"multiple_suppliers": {
"required": false,
"description": "Limit result set to purchase orders depending on their multiple_suppliers switch status.",
"type": "boolean"
}
}
},
{
"methods": [
"POST"
],
"args": {
"status": {
"required": false,
"default": "atum_pending",
"enum": [
"atum_pending",
"atum_ordered",
"atum_onthewayin",
"atum_receiving",
"atum_received"
],
"description": "Order status.",
"type": "string"
},
"currency": {
"required": false,
"default": "EUR",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYR",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"IRT",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PRB",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
],
"description": "Currency the order was created with, in ISO format.",
"type": "string"
},
"meta_data": {
"required": false,
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
},
"line_items": {
"required": false,
"description": "Line items data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Product name.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"product_id": {
"description": "Product ID.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"variation_id": {
"description": "Variation ID, if applicable.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity": {
"description": "Quantity ordered.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of product.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Line subtotal (before discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal_tax": {
"description": "Line subtotal tax (before discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
},
"sku": {
"description": "Product SKU.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"price": {
"description": "Product price.",
"type": "number",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"shipping_lines": {
"required": false,
"description": "Shipping lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"method_title": {
"description": "Shipping method name.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"method_id": {
"description": "Shipping method ID.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"instance_id": {
"description": "Shipping instance ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
}
},
"fee_lines": {
"required": false,
"description": "Fee lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Fee name.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of fee.",
"type": "string",
"context": [
"view",
"edit"
]
},
"tax_status": {
"description": "Tax status of fee.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"taxable",
"none"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
}
},
"description": {
"required": false,
"description": "The ATUM order description.",
"type": "string"
},
"date_expected": {
"required": false,
"description": "The date when the purchase order is expected at location.",
"type": "date-time"
},
"supplier": {
"required": false,
"description": "The supplier ID linked to the purchase order.",
"type": "integer"
},
"multiple_suppliers": {
"required": false,
"description": "Whether the multiple_suppliers switch is enabled or not.",
"type": "boolean"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/atum/purchase-orders"
}
},
"/wc/v3/atum/purchase-orders/(?P<id>[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"status": {
"required": false,
"enum": [
"atum_pending",
"atum_ordered",
"atum_onthewayin",
"atum_receiving",
"atum_received"
],
"description": "Order status.",
"type": "string"
},
"currency": {
"required": false,
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYR",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"IRT",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PRB",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
],
"description": "Currency the order was created with, in ISO format.",
"type": "string"
},
"meta_data": {
"required": false,
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
},
"line_items": {
"required": false,
"description": "Line items data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Product name.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"product_id": {
"description": "Product ID.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"variation_id": {
"description": "Variation ID, if applicable.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity": {
"description": "Quantity ordered.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of product.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Line subtotal (before discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal_tax": {
"description": "Line subtotal tax (before discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
},
"sku": {
"description": "Product SKU.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"price": {
"description": "Product price.",
"type": "number",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"shipping_lines": {
"required": false,
"description": "Shipping lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"method_title": {
"description": "Shipping method name.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"method_id": {
"description": "Shipping method ID.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"instance_id": {
"description": "Shipping instance ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
}
},
"fee_lines": {
"required": false,
"description": "Fee lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Fee name.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of fee.",
"type": "string",
"context": [
"view",
"edit"
]
},
"tax_status": {
"description": "Tax status of fee.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"taxable",
"none"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
}
},
"description": {
"required": false,
"description": "The ATUM order description.",
"type": "string"
},
"date_expected": {
"required": false,
"description": "The date when the purchase order is expected at location.",
"type": "date-time"
},
"supplier": {
"required": false,
"description": "The supplier ID linked to the purchase order.",
"type": "integer"
},
"multiple_suppliers": {
"required": false,
"description": "Whether the multiple_suppliers switch is enabled or not.",
"type": "boolean"
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"force": {
"required": false,
"default": false,
"description": "Whether to bypass bin and force deletion.",
"type": "boolean"
}
}
}
]
},
"/wc/v3/atum/purchase-orders/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"status": {
"required": false,
"enum": [
"atum_pending",
"atum_ordered",
"atum_onthewayin",
"atum_receiving",
"atum_received"
],
"description": "Order status.",
"type": "string"
},
"currency": {
"required": false,
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYR",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"IRT",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PRB",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
],
"description": "Currency the order was created with, in ISO format.",
"type": "string"
},
"meta_data": {
"required": false,
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
},
"line_items": {
"required": false,
"description": "Line items data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Product name.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"product_id": {
"description": "Product ID.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"variation_id": {
"description": "Variation ID, if applicable.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity": {
"description": "Quantity ordered.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of product.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Line subtotal (before discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal_tax": {
"description": "Line subtotal tax (before discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
},
"sku": {
"description": "Product SKU.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"price": {
"description": "Product price.",
"type": "number",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"shipping_lines": {
"required": false,
"description": "Shipping lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"method_title": {
"description": "Shipping method name.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"method_id": {
"description": "Shipping method ID.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"instance_id": {
"description": "Shipping instance ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
}
},
"fee_lines": {
"required": false,
"description": "Fee lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Fee name.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of fee.",
"type": "string",
"context": [
"view",
"edit"
]
},
"tax_status": {
"description": "Tax status of fee.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"taxable",
"none"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
}
},
"description": {
"required": false,
"description": "The ATUM order description.",
"type": "string"
},
"date_expected": {
"required": false,
"description": "The date when the purchase order is expected at location.",
"type": "date-time"
},
"supplier": {
"required": false,
"description": "The supplier ID linked to the purchase order.",
"type": "integer"
},
"multiple_suppliers": {
"required": false,
"description": "Whether the multiple_suppliers switch is enabled or not.",
"type": "boolean"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/atum/purchase-orders/batch"
}
},
"/wc/v3/atum/purchase-orders/(?P<order_id>[\\d]+)/notes": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"order_id": {
"required": false,
"description": "The order ID.",
"type": "integer"
},
"type": {
"required": false,
"default": "any",
"enum": [
"any",
"user",
"system"
],
"description": "Limit result to user or system notes.",
"type": "string"
}
}
},
{
"methods": [
"POST"
],
"args": {
"order_id": {
"required": false,
"description": "The order ID.",
"type": "integer"
},
"note": {
"required": true,
"description": "Order note content.",
"type": "string"
},
"added_by_user": {
"required": false,
"default": false,
"description": "If true, this note will be attributed to the current user. If false, the note will be attributed to the system.",
"type": "boolean"
}
}
}
]
},
"/wc/v3/atum/purchase-orders/(?P<order_id>[\\d]+)/notes/(?P<id>[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"order_id": {
"required": false,
"description": "The order ID.",
"type": "integer"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"order_id": {
"required": false,
"description": "The order ID.",
"type": "integer"
},
"force": {
"required": false,
"default": false,
"description": "Required to be true, as resource does not support binning.",
"type": "boolean"
}
}
}
]
},
"/wc/v3/atum/inventory-logs": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
},
"page": {
"required": false,
"default": 1,
"description": "Current page of the collection.",
"type": "integer"
},
"per_page": {
"required": false,
"default": 10,
"description": "Maximum number of items to be returned in result set.",
"type": "integer"
},
"search": {
"required": false,
"description": "Limit results to those matching a string.",
"type": "string"
},
"after": {
"required": false,
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string"
},
"before": {
"required": false,
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string"
},
"exclude": {
"required": false,
"default": [],
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"include": {
"required": false,
"default": [],
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
}
},
"offset": {
"required": false,
"description": "Offset the result set by a specific number of items.",
"type": "integer"
},
"order": {
"required": false,
"description": "Limit result set to inventory logs linked to the specified WC order ID.",
"type": "integer"
},
"orderby": {
"required": false,
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug"
],
"description": "Sort collection by object attribute.",
"type": "string"
},
"parent": {
"required": false,
"default": [],
"description": "Limit result set to those of particular parent IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"parent_exclude": {
"required": false,
"default": [],
"description": "Limit result set to all items except those of a particular parent ID.",
"type": "array",
"items": {
"type": "integer"
}
},
"status": {
"required": false,
"default": "any",
"description": "Limit result set to ATUM orders which have specific statuses.",
"type": "array",
"items": {
"type": "string",
"enum": [
"any",
"trash",
"atum_pending",
"atum_completed"
]
}
},
"product": {
"required": false,
"description": "Limit result set to orders assigned a specific product.",
"type": "integer"
},
"dp": {
"required": false,
"default": 2,
"description": "Number of decimal points to use in each resource.",
"type": "integer"
},
"type": {
"required": false,
"description": "Limit result set to inventory logs of the specified type(s).",
"type": "array",
"items": {
"type": "string",
"enum": [
"reserved-stock",
"customer-returns",
"warehouse-damage",
"lost-in-post",
"other"
]
}
},
"reservation_date": {
"required": false,
"description": "Limit result set to inventory logs with the reservation date set on a given ISO8601 compliant date.",
"type": "string"
},
"return_date": {
"required": false,
"description": "Limit result set to inventory logs with the return date set on a given ISO8601 compliant date.",
"type": "string"
},
"damage_date": {
"required": false,
"description": "Limit result set to inventory logs with the damage date set on a given ISO8601 compliant date.",
"type": "string"
},
"shipping_company": {
"required": false,
"description": "Limit result set to the inventory logs where the specified company lost the stock in post.",
"type": "string"
},
"custom_name": {
"required": false,
"description": "Limit result set to the inventory logs with type 'other' and the specified custom name.",
"type": "string"
}
}
},
{
"methods": [
"POST"
],
"args": {
"status": {
"required": false,
"default": "atum_pending",
"enum": [
"atum_pending",
"atum_completed"
],
"description": "Order status.",
"type": "string"
},
"currency": {
"required": false,
"default": "EUR",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYR",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"IRT",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PRB",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
],
"description": "Currency the order was created with, in ISO format.",
"type": "string"
},
"meta_data": {
"required": false,
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
},
"line_items": {
"required": false,
"description": "Line items data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Product name.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"product_id": {
"description": "Product ID.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"variation_id": {
"description": "Variation ID, if applicable.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity": {
"description": "Quantity ordered.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of product.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Line subtotal (before discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal_tax": {
"description": "Line subtotal tax (before discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
},
"sku": {
"description": "Product SKU.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"price": {
"description": "Product price.",
"type": "number",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"shipping_lines": {
"required": false,
"description": "Shipping lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"method_title": {
"description": "Shipping method name.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"method_id": {
"description": "Shipping method ID.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"instance_id": {
"description": "Shipping instance ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
}
},
"fee_lines": {
"required": false,
"description": "Fee lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Fee name.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of fee.",
"type": "string",
"context": [
"view",
"edit"
]
},
"tax_status": {
"description": "Tax status of fee.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"taxable",
"none"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
}
},
"description": {
"required": false,
"description": "The ATUM order description.",
"type": "string"
},
"type": {
"required": false,
"enum": [
"reserved-stock",
"customer-returns",
"warehouse-damage",
"lost-in-post",
"other"
],
"description": "The log type.",
"type": "string"
},
"order": {
"required": false,
"description": "The WooCommerce's order ID to which this Log is linked to.",
"type": "integer"
},
"reservation_date": {
"required": false,
"description": "The date for when the stock is reserved.",
"type": "date-time"
},
"return_date": {
"required": false,
"description": "The date for when the customer returned the stock.",
"type": "date-time"
},
"damage_date": {
"required": false,
"description": "The date for when the stock was damaged at warehouse.",
"type": "date-time"
},
"shipping_company": {
"required": false,
"description": "The name of the company that lost in post.",
"type": "string"
},
"custom_name": {
"required": false,
"description": "The custom name for the 'other' log types.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/atum/inventory-logs"
}
},
"/wc/v3/atum/inventory-logs/(?P<id>[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"status": {
"required": false,
"enum": [
"atum_pending",
"atum_completed"
],
"description": "Order status.",
"type": "string"
},
"currency": {
"required": false,
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYR",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"IRT",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PRB",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
],
"description": "Currency the order was created with, in ISO format.",
"type": "string"
},
"meta_data": {
"required": false,
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
},
"line_items": {
"required": false,
"description": "Line items data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Product name.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"product_id": {
"description": "Product ID.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"variation_id": {
"description": "Variation ID, if applicable.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity": {
"description": "Quantity ordered.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of product.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Line subtotal (before discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal_tax": {
"description": "Line subtotal tax (before discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
},
"sku": {
"description": "Product SKU.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"price": {
"description": "Product price.",
"type": "number",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"shipping_lines": {
"required": false,
"description": "Shipping lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"method_title": {
"description": "Shipping method name.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"method_id": {
"description": "Shipping method ID.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"instance_id": {
"description": "Shipping instance ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
}
},
"fee_lines": {
"required": false,
"description": "Fee lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Fee name.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of fee.",
"type": "string",
"context": [
"view",
"edit"
]
},
"tax_status": {
"description": "Tax status of fee.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"taxable",
"none"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
}
},
"description": {
"required": false,
"description": "The ATUM order description.",
"type": "string"
},
"type": {
"required": false,
"enum": [
"reserved-stock",
"customer-returns",
"warehouse-damage",
"lost-in-post",
"other"
],
"description": "The log type.",
"type": "string"
},
"order": {
"required": false,
"description": "The WooCommerce's order ID to which this Log is linked to.",
"type": "integer"
},
"reservation_date": {
"required": false,
"description": "The date for when the stock is reserved.",
"type": "date-time"
},
"return_date": {
"required": false,
"description": "The date for when the customer returned the stock.",
"type": "date-time"
},
"damage_date": {
"required": false,
"description": "The date for when the stock was damaged at warehouse.",
"type": "date-time"
},
"shipping_company": {
"required": false,
"description": "The name of the company that lost in post.",
"type": "string"
},
"custom_name": {
"required": false,
"description": "The custom name for the 'other' log types.",
"type": "string"
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"force": {
"required": false,
"default": false,
"description": "Whether to bypass bin and force deletion.",
"type": "boolean"
}
}
}
]
},
"/wc/v3/atum/inventory-logs/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"status": {
"required": false,
"enum": [
"atum_pending",
"atum_completed"
],
"description": "Order status.",
"type": "string"
},
"currency": {
"required": false,
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTC",
"BTN",
"BWP",
"BYR",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"IMP",
"INR",
"IQD",
"IRR",
"IRT",
"ISK",
"JEP",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PRB",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
],
"description": "Currency the order was created with, in ISO format.",
"type": "string"
},
"meta_data": {
"required": false,
"description": "Meta data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
},
"line_items": {
"required": false,
"description": "Line items data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Product name.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"product_id": {
"description": "Product ID.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"variation_id": {
"description": "Variation ID, if applicable.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"quantity": {
"description": "Quantity ordered.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of product.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Line subtotal (before discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal_tax": {
"description": "Line subtotal tax (before discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
]
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
]
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
},
"sku": {
"description": "Product SKU.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"price": {
"description": "Product price.",
"type": "number",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"shipping_lines": {
"required": false,
"description": "Shipping lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"method_title": {
"description": "Shipping method name.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"method_id": {
"description": "Shipping method ID.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"instance_id": {
"description": "Shipping instance ID.",
"type": "string",
"context": [
"view",
"edit"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
}
},
"fee_lines": {
"required": false,
"description": "Fee lines data.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Item ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"name": {
"description": "Fee name.",
"type": "mixed",
"context": [
"view",
"edit"
]
},
"tax_class": {
"description": "Tax class of fee.",
"type": "string",
"context": [
"view",
"edit"
]
},
"tax_status": {
"description": "Tax status of fee.",
"type": "string",
"context": [
"view",
"edit"
],
"enum": [
"taxable",
"none"
]
},
"total": {
"description": "Line total (after discounts).",
"type": "string",
"context": [
"view",
"edit"
]
},
"total_tax": {
"description": "Line total tax (after discounts).",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"taxes": {
"description": "Line taxes.",
"type": "array",
"context": [
"view",
"edit"
],
"readonly": true,
"items": {
"type": "object",
"properties": {
"id": {
"description": "Tax rate ID",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"total": {
"description": "Tax total.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
},
"subtotal": {
"description": "Tax subtotal.",
"type": "string",
"context": [
"view",
"edit"
],
"readonly": true
}
}
}
},
"meta_data": {
"description": "Meta data.",
"type": "array",
"context": [
"view",
"edit"
],
"items": {
"type": "object",
"properties": {
"id": {
"description": "Meta ID.",
"type": "integer",
"context": [
"view",
"edit"
],
"readonly": true
},
"key": {
"description": "Meta key.",
"type": "string",
"context": [
"view",
"edit"
]
},
"value": {
"description": "Meta value.",
"type": "mixed",
"context": [
"view",
"edit"
]
}
}
}
}
}
}
},
"description": {
"required": false,
"description": "The ATUM order description.",
"type": "string"
},
"type": {
"required": false,
"enum": [
"reserved-stock",
"customer-returns",
"warehouse-damage",
"lost-in-post",
"other"
],
"description": "The log type.",
"type": "string"
},
"order": {
"required": false,
"description": "The WooCommerce's order ID to which this Log is linked to.",
"type": "integer"
},
"reservation_date": {
"required": false,
"description": "The date for when the stock is reserved.",
"type": "date-time"
},
"return_date": {
"required": false,
"description": "The date for when the customer returned the stock.",
"type": "date-time"
},
"damage_date": {
"required": false,
"description": "The date for when the stock was damaged at warehouse.",
"type": "date-time"
},
"shipping_company": {
"required": false,
"description": "The name of the company that lost in post.",
"type": "string"
},
"custom_name": {
"required": false,
"description": "The custom name for the 'other' log types.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/atum/inventory-logs/batch"
}
},
"/wc/v3/atum/inventory-logs/(?P<order_id>[\\d]+)/notes": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"order_id": {
"required": false,
"description": "The order ID.",
"type": "integer"
},
"type": {
"required": false,
"default": "any",
"enum": [
"any",
"user",
"system"
],
"description": "Limit result to user or system notes.",
"type": "string"
}
}
},
{
"methods": [
"POST"
],
"args": {
"order_id": {
"required": false,
"description": "The order ID.",
"type": "integer"
},
"note": {
"required": true,
"description": "Order note content.",
"type": "string"
},
"added_by_user": {
"required": false,
"default": false,
"description": "If true, this note will be attributed to the current user. If false, the note will be attributed to the system.",
"type": "boolean"
}
}
}
]
},
"/wc/v3/atum/inventory-logs/(?P<order_id>[\\d]+)/notes/(?P<id>[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"order_id": {
"required": false,
"description": "The order ID.",
"type": "integer"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"order_id": {
"required": false,
"description": "The order ID.",
"type": "integer"
},
"force": {
"required": false,
"default": false,
"description": "Required to be true, as resource does not support binning.",
"type": "boolean"
}
}
}
]
},
"/wc/v3/atum/settings": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/atum/settings"
}
},
"/wc/v3/atum/settings/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": []
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/atum/settings/batch"
}
},
"/wc/v3/atum/settings/(?P<group_id>[\\w-]+)": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"group": {
"required": false,
"description": "Settings group ID.",
"type": "string"
}
}
}
]
},
"/wc/v3/atum/settings/(?P<group_id>[\\w-]+)/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"group": {
"required": false,
"description": "Settings group ID.",
"type": "string"
},
"value": {
"required": false,
"description": "Setting value.",
"type": "mixed"
}
}
}
]
},
"/wc/v3/atum/settings/(?P<group_id>[\\w-]+)/(?P<id>[\\w-]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"group": {
"required": false,
"description": "Settings group ID.",
"type": "string"
},
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "string"
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"group": {
"required": false,
"description": "Settings group ID.",
"type": "string"
},
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "string"
},
"value": {
"required": false,
"description": "Setting value.",
"type": "mixed"
}
}
}
]
},
"/wc/v3/products/atum-locations": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
},
"page": {
"required": false,
"default": 1,
"description": "Current page of the collection.",
"type": "integer"
},
"per_page": {
"required": false,
"default": 10,
"description": "Maximum number of items to be returned in result set.",
"type": "integer"
},
"search": {
"required": false,
"description": "Limit results to those matching a string.",
"type": "string"
},
"exclude": {
"required": false,
"default": [],
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"include": {
"required": false,
"default": [],
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
}
},
"order": {
"required": false,
"default": "asc",
"enum": [
"asc",
"desc"
],
"description": "Order sort attribute ascending or descending.",
"type": "string"
},
"orderby": {
"required": false,
"default": "name",
"enum": [
"id",
"include",
"name",
"slug",
"term_group",
"description",
"count"
],
"description": "Sort collection by resource attribute.",
"type": "string"
},
"hide_empty": {
"required": false,
"default": false,
"description": "Whether to hide resources not assigned to any products.",
"type": "boolean"
},
"parent": {
"required": false,
"description": "Limit result set to resources assigned to a specific parent.",
"type": "integer"
},
"product": {
"required": false,
"description": "Limit result set to resources assigned to a specific product.",
"type": "integer"
},
"slug": {
"required": false,
"description": "Limit result set to resources with a specific slug.",
"type": "string"
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"required": true,
"description": "Name for the resource.",
"type": "string"
},
"slug": {
"required": false,
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string"
},
"parent": {
"required": false,
"description": "The ID for the parent of the resource.",
"type": "integer"
},
"description": {
"required": false,
"description": "HTML description of the resource.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/products/atum-locations"
}
},
"/wc/v3/products/atum-locations/(?P<id>[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"name": {
"required": false,
"description": "Category name.",
"type": "string"
},
"slug": {
"required": false,
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string"
},
"parent": {
"required": false,
"description": "The ID for the parent of the resource.",
"type": "integer"
},
"description": {
"required": false,
"description": "HTML description of the resource.",
"type": "string"
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"force": {
"required": false,
"default": false,
"description": "Required to be true, as resource does not support binning.",
"type": "boolean"
}
}
}
]
},
"/wc/v3/products/atum-locations/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"required": false,
"description": "Category name.",
"type": "string"
},
"slug": {
"required": false,
"description": "An alphanumeric identifier for the resource unique to its type.",
"type": "string"
},
"parent": {
"required": false,
"description": "The ID for the parent of the resource.",
"type": "integer"
},
"description": {
"required": false,
"description": "HTML description of the resource.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/products/atum-locations/batch"
}
},
"/wc/v3/atum/inbound-stock": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"page": {
"required": false,
"default": 1,
"description": "Current page of the collection.",
"type": "integer"
},
"per_page": {
"required": false,
"default": 10,
"description": "Maximum number of items to be returned in result set.",
"type": "integer"
},
"search": {
"required": false,
"description": "Limit results to those matching a string.",
"type": "string"
},
"after": {
"required": false,
"description": "Limit response to resources published after a given ISO8601 compliant date.",
"type": "string"
},
"before": {
"required": false,
"description": "Limit response to resources published before a given ISO8601 compliant date.",
"type": "string"
},
"exclude": {
"required": false,
"default": [],
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"include": {
"required": false,
"default": [],
"description": "Limit result set to specific ids.",
"type": "array",
"items": {
"type": "integer"
}
},
"offset": {
"required": false,
"description": "Offset the result set by a specific number of items.",
"type": "integer"
},
"order": {
"required": false,
"default": "desc",
"enum": [
"asc",
"desc"
],
"description": "Order sort attribute ascending or descending.",
"type": "string"
},
"orderby": {
"required": false,
"default": "date",
"enum": [
"date",
"id",
"include",
"title",
"slug",
"price",
"popularity",
"rating"
],
"description": "Sort collection by object attribute.",
"type": "string"
},
"include_po": {
"required": false,
"default": [],
"description": "Limit result set to products with specified Purchase Order IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"exclude_po": {
"required": false,
"default": [],
"description": "Ensure result set excludes specific Purchasr Order IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"expected_after": {
"required": false,
"description": "Limit response to purchase orders expected after a given ISO8601 compliant date.",
"type": "string"
},
"expected_before": {
"required": false,
"description": "Limit response to purchase orders expected before a given ISO8601 compliant date.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/atum/inbound-stock"
}
},
"/wc/v3/atum/inbound-stock/(?P<id>[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
}
]
},
"/wc/v3/atum/addons": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": []
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/atum/addons"
}
},
"/wc/v3/atum/dashboard": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/atum/dashboard"
}
},
"/wc/v3/atum/dashboard/statistics": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
},
"data": {
"required": false,
"default": "sales",
"enum": [
"sales",
"lost-sales",
"promo-sales",
"orders"
],
"description": "The type of data to return.",
"type": "string"
},
"period": {
"required": false,
"default": "this_year",
"enum": [
"this_year",
"previous_year",
"this_month",
"previous_month",
"this_week",
"previous_week"
],
"description": "The period to get statistics from.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/atum/dashboard/statistics"
}
},
"/wc/v3/atum/dashboard/sales": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
},
"period": {
"required": false,
"default": "today",
"enum": [
"today",
"month"
],
"description": "The period to get sales data from.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/atum/dashboard/sales"
}
},
"/wc/v3/atum/dashboard/lost-sales": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
},
"period": {
"required": false,
"default": "today",
"enum": [
"today",
"month"
],
"description": "The period to get lost sales data from.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/atum/dashboard/lost-sales"
}
},
"/wc/v3/atum/dashboard/orders": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
},
"period": {
"required": false,
"default": "this_month",
"enum": [
"this_month",
"previous_month",
"this_week",
"today"
],
"description": "The period to get o data from.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/atum/dashboard/orders"
}
},
"/wc/v3/atum/dashboard/promo-sales": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
},
"period": {
"required": false,
"default": "this_month",
"enum": [
"this_month",
"previous_month",
"this_week",
"today"
],
"description": "The period to get the promo sales data from.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/atum/dashboard/promo-sales"
}
},
"/wc/v3/atum/dashboard/stock-control": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/atum/dashboard/stock-control"
}
},
"/wc/v3/atum/dashboard/current-stock-value": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/atum/dashboard/current-stock-value"
}
},
"/wc/v3/atum/tools": {
"namespace": "wc/v3",
"methods": [
"GET"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
}
],
"_links": {
"self": "https://example.com/wp-json/wc/v3/atum/tools"
}
},
"/wc/v3/atum/tools/(?P<id>[\\w-]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "string"
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"required": false,
"description": "A unique identifier for the tool.",
"type": "string"
},
"name": {
"required": false,
"description": "Tool nice name.",
"type": "string"
},
"description": {
"required": false,
"description": "Tool description.",
"type": "string"
},
"config": {
"required": false,
"description": "If the tool needs config in order to work.",
"type": "object"
},
"success": {
"required": false,
"description": "Did the tool run successfully?",
"type": "boolean"
},
"message": {
"required": false,
"description": "Tool return message.",
"type": "string"
}
}
}
]
},
"/wc/v3/products/(?P<product_id>[\\d]+)/inventories": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"context": {
"required": false,
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
},
"page": {
"required": false,
"default": 1,
"description": "Current page of the collection.",
"type": "integer"
},
"per_page": {
"required": false,
"default": 10,
"description": "Maximum number of items to be returned in result set.",
"type": "integer"
},
"search": {
"required": false,
"description": "Limit results to those matching a string.",
"type": "string"
},
"shipping_zone": {
"required": false,
"enum": {
"2": "UK",
"7": "France",
"9": "Massalaves",
"4": "Italy",
"6": "Spain",
"3": "Spain Regions"
},
"description": "If the shipping zone restriction mode is enabled, limit the result set to inventories linked to the specified shipping zone.",
"type": "string"
},
"after": {
"required": false,
"description": "Limit response to resources created after a given ISO8601 compliant date.",
"type": "string"
},
"before": {
"required": false,
"description": "Limit response to resources created before a given ISO8601 compliant date.",
"type": "string"
},
"exclude": {
"required": false,
"default": [],
"description": "Ensure result set excludes specific IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"include": {
"required": false,
"default": [],
"description": "Limit result set to specific IDs.",
"type": "array",
"items": {
"type": "integer"
}
},
"offset": {
"required": false,
"description": "Offset the result set by a specific number of items.",
"type": "integer"
},
"order": {
"required": false,
"default": "asc",
"enum": [
"asc",
"desc"
],
"description": "Order sort attribute ascending or descending.",
"type": "string"
},
"orderby": {
"required": false,
"default": "priority",
"enum": [
"priority",
"inventory_date",
"id",
"name",
"bbe_date"
],
"description": "Sort collection by object attribute.",
"type": "string"
},
"name": {
"required": false,
"description": "Limit result set to inventories with a specific name.",
"type": "string"
},
"exclude_write_off": {
"required": false,
"default": true,
"description": "Exclude from result set the inventories that were marked as 'write off'.",
"type": "boolean"
},
"lot": {
"required": false,
"description": "Limit result set to inventories with the specified LOT/BATCH number.",
"type": "string"
}
}
},
{
"methods": [
"POST"
],
"args": {
"name": {
"required": false,
"description": "The inventory name.",
"type": "string"
},
"priority": {
"required": false,
"description": "The priority index within the list of the product inventories' list.",
"type": "integer"
},
"is_main": {
"required": false,
"description": "Whether the current inventory is the main inventory.",
"type": "boolean"
},
"inventory_date": {
"required": false,
"description": "The date the inventory was created, as GMT.",
"type": "date-time"
},
"lot": {
"required": false,
"description": "The LOT/BATCH number.",
"type": "string"
},
"write_off": {
"required": false,
"description": "Whether the current inventory was marked as 'write-off'.",
"type": "boolean"
},
"region": {
"required": false,
"description": "If the region restriction mode is enabled, it'll show the list of countries or shipping zones linked to the inventory.",
"type": "array"
},
"location": {
"required": false,
"description": "ATUM Location(s) linked to the inventory.",
"type": "array"
},
"bbe_date": {
"required": false,
"description": "The Best-Before-Expiry date for the inventory, as GMT.",
"type": "date-time"
},
"update_date": {
"required": false,
"description": "Last date when the inventory data was calculated and saved for this product, as GMT.",
"type": "date-time"
},
"meta_data": {
"required": false,
"description": "Meta data.",
"type": "object",
"items": {
"type": "object",
"properties": {
"sku": {
"description": "Inventory's SKU.",
"type": "string",
"context": [
"view",
"edit"
]
},
"manage_stock": {
"description": "Whether the back orders are allowed.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"stock_quantity": {
"description": "Inventory's stock amount.",
"type": "number",
"context": [
"view",
"edit"
]
},
"stock_status": {
"description": "Inventory's stock status.",
"type": "string",
"context": [
"view",
"edit"
]
},
"supplier_id": {
"description": "Inventoy supplier's ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"supplier_sku": {
"description": "Inventory supplier's SKU.",
"type": "string",
"context": [
"view",
"edit"
]
},
"sold_individually": {
"description": "Whether the inventory should be sold individually.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"out_stock_threshold": {
"description": "Inventory's out of stock threshold.",
"type": "number",
"context": [
"view",
"edit"
]
},
"purchase_price": {
"description": "Inventory's purchase price.",
"type": "number",
"context": [
"view",
"edit"
]
},
"price": {
"description": "Inventory's price.",
"type": "number",
"context": [
"view",
"edit"
]
},
"regular_price": {
"description": "Inventory's regular price.",
"type": "number",
"context": [
"view",
"edit"
]
},
"sale_price": {
"description": "Inventory's sale price.",
"type": "number",
"context": [
"view",
"edit"
]
},
"date_on_sale_from": {
"description": "The date when starts the sale price, as GMT.",
"type": "date-time",
"context": [
"view",
"edit"
]
},
"date_on_sale_to": {
"description": "The date when ends the sale price, as GMT.",
"type": "date-time",
"context": [
"view",
"edit"
]
},
"out_stock_date": {
"description": "The date when the inventory run out of stock, as GMT.",
"type": "date-time",
"context": [
"view",
"edit"
]
}
}
}
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"force": {
"required": false,
"default": false,
"description": "Whether to bypass trash and force deletion.",
"type": "boolean"
}
}
}
]
},
"/wc/v3/products/(?P<product_id>[\\d]+)/inventories/(?P<id>[\\d]+)": {
"namespace": "wc/v3",
"methods": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"endpoints": [
{
"methods": [
"GET"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"context": {
"required": false,
"default": "view",
"enum": [
"view",
"edit"
],
"description": "Scope under which the request is made; determines fields present in response.",
"type": "string"
}
}
},
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"name": {
"required": false,
"description": "The inventory name.",
"type": "string"
},
"priority": {
"required": false,
"description": "The priority index within the list of the product inventories' list.",
"type": "integer"
},
"is_main": {
"required": false,
"description": "Whether the current inventory is the main inventory.",
"type": "boolean"
},
"inventory_date": {
"required": false,
"description": "The date the inventory was created, as GMT.",
"type": "date-time"
},
"lot": {
"required": false,
"description": "The LOT/BATCH number.",
"type": "string"
},
"write_off": {
"required": false,
"description": "Whether the current inventory was marked as 'write-off'.",
"type": "boolean"
},
"region": {
"required": false,
"description": "If the region restriction mode is enabled, it'll show the list of countries or shipping zones linked to the inventory.",
"type": "array"
},
"location": {
"required": false,
"description": "ATUM Location(s) linked to the inventory.",
"type": "array"
},
"bbe_date": {
"required": false,
"description": "The Best-Before-Expiry date for the inventory, as GMT.",
"type": "date-time"
},
"update_date": {
"required": false,
"description": "Last date when the inventory data was calculated and saved for this product, as GMT.",
"type": "date-time"
},
"meta_data": {
"required": false,
"description": "Meta data.",
"type": "object",
"items": {
"type": "object",
"properties": {
"sku": {
"description": "Inventory's SKU.",
"type": "string",
"context": [
"view",
"edit"
]
},
"manage_stock": {
"description": "Whether the back orders are allowed.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"stock_quantity": {
"description": "Inventory's stock amount.",
"type": "number",
"context": [
"view",
"edit"
]
},
"stock_status": {
"description": "Inventory's stock status.",
"type": "string",
"context": [
"view",
"edit"
]
},
"supplier_id": {
"description": "Inventoy supplier's ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"supplier_sku": {
"description": "Inventory supplier's SKU.",
"type": "string",
"context": [
"view",
"edit"
]
},
"sold_individually": {
"description": "Whether the inventory should be sold individually.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"out_stock_threshold": {
"description": "Inventory's out of stock threshold.",
"type": "number",
"context": [
"view",
"edit"
]
},
"purchase_price": {
"description": "Inventory's purchase price.",
"type": "number",
"context": [
"view",
"edit"
]
},
"price": {
"description": "Inventory's price.",
"type": "number",
"context": [
"view",
"edit"
]
},
"regular_price": {
"description": "Inventory's regular price.",
"type": "number",
"context": [
"view",
"edit"
]
},
"sale_price": {
"description": "Inventory's sale price.",
"type": "number",
"context": [
"view",
"edit"
]
},
"date_on_sale_from": {
"description": "The date when starts the sale price, as GMT.",
"type": "date-time",
"context": [
"view",
"edit"
]
},
"date_on_sale_to": {
"description": "The date when ends the sale price, as GMT.",
"type": "date-time",
"context": [
"view",
"edit"
]
},
"out_stock_date": {
"description": "The date when the inventory run out of stock, as GMT.",
"type": "date-time",
"context": [
"view",
"edit"
]
}
}
}
}
}
},
{
"methods": [
"DELETE"
],
"args": {
"id": {
"required": false,
"description": "Unique identifier for the resource.",
"type": "integer"
},
"force": {
"required": false,
"default": false,
"description": "Whether to bypass trash and force deletion.",
"type": "boolean"
}
}
}
]
},
"/wc/v3/products/(?P<product_id>[\\d]+)/inventories/batch": {
"namespace": "wc/v3",
"methods": [
"POST",
"PUT",
"PATCH"
],
"endpoints": [
{
"methods": [
"POST",
"PUT",
"PATCH"
],
"args": {
"name": {
"required": false,
"description": "The inventory name.",
"type": "string"
},
"priority": {
"required": false,
"description": "The priority index within the list of the product inventories' list.",
"type": "integer"
},
"is_main": {
"required": false,
"description": "Whether the current inventory is the main inventory.",
"type": "boolean"
},
"inventory_date": {
"required": false,
"description": "The date the inventory was created, as GMT.",
"type": "date-time"
},
"lot": {
"required": false,
"description": "The LOT/BATCH number.",
"type": "string"
},
"write_off": {
"required": false,
"description": "Whether the current inventory was marked as 'write-off'.",
"type": "boolean"
},
"region": {
"required": false,
"description": "If the region restriction mode is enabled, it'll show the list of countries or shipping zones linked to the inventory.",
"type": "array"
},
"location": {
"required": false,
"description": "ATUM Location(s) linked to the inventory.",
"type": "array"
},
"bbe_date": {
"required": false,
"description": "The Best-Before-Expiry date for the inventory, as GMT.",
"type": "date-time"
},
"update_date": {
"required": false,
"description": "Last date when the inventory data was calculated and saved for this product, as GMT.",
"type": "date-time"
},
"meta_data": {
"required": false,
"description": "Meta data.",
"type": "object",
"items": {
"type": "object",
"properties": {
"sku": {
"description": "Inventory's SKU.",
"type": "string",
"context": [
"view",
"edit"
]
},
"manage_stock": {
"description": "Whether the back orders are allowed.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"stock_quantity": {
"description": "Inventory's stock amount.",
"type": "number",
"context": [
"view",
"edit"
]
},
"stock_status": {
"description": "Inventory's stock status.",
"type": "string",
"context": [
"view",
"edit"
]
},
"supplier_id": {
"description": "Inventoy supplier's ID.",
"type": "integer",
"context": [
"view",
"edit"
]
},
"supplier_sku": {
"description": "Inventory supplier's SKU.",
"type": "string",
"context": [
"view",
"edit"
]
},
"sold_individually": {
"description": "Whether the inventory should be sold individually.",
"type": "boolean",
"context": [
"view",
"edit"
]
},
"out_stock_threshold": {
"description": "Inventory's out of stock threshold.",
"type": "number",
"context": [
"view",
"edit"
]
},
"purchase_price": {
"description": "Inventory's purchase price.",
"type": "number",
"context": [
"view",
"edit"
]
},
"price": {
"description": "Inventory's price.",
"type": "number",
"context": [
"view",
"edit"
]
},
"regular_price": {
"description": "Inventory's regular price.",
"type": "number",
"context": [
"view",
"edit"
]
},
"sale_price": {
"description": "Inventory's sale price.",
"type": "number",
"context": [
"view",
"edit"
]
},
"date_on_sale_from": {
"description": "The date when starts the sale price, as GMT.",
"type": "date-time",
"context": [
"view",
"edit"
]
},
"date_on_sale_to": {
"description": "The date when ends the sale price, as GMT.",
"type": "date-time",
"context": [
"view",
"edit"
]
},
"out_stock_date": {
"description": "The date when the inventory run out of stock, as GMT.",
"type": "date-time",
"context": [
"view",
"edit"
]
}
}
}
}
}
}
]
}
},
"_links": {
"up": [
{
"href": "https://example.com/wp-json/"
}
]
}
}
Add-ons
ATUM
The add-ons API allows you to view the installed ATUM add-ons and their licenses.
Add-on properties
| Attribute | Type | Description |
|---|---|---|
name |
string | The add-on name. read-only |
key |
string | The license key for the purchased add-on. read-only |
status |
string | The license key status. read-only |
List all add-ons
This API helps you to view all the add-ons.
HTTP request
GET
/wp-json/wc/v3/atum/addons
curl https://example.com/wp-json/wc/v3/atum/addons \
-u consumer_key:consumer_secret
WooCommerce.get("atum/addons")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('atum/addons')); ?>
print(wcapi.get("atum/addons").json())
woocommerce.get("atum/addons").parsed_response
JSON response example:
[
{
"name": "Product Levels",
"key": "XXXXXX",
"status": "valid"
},
{
"name": "Stock Takes",
"key": "",
"status": "invalid"
},
{
"name": "Stock Logs",
"key": "",
"status": "invalid"
},
{
"name": "Dashboard Statistics Pro",
"key": "",
"status": "invalid"
},
{
"name": "User Restrictions",
"key": "",
"status": "invalid"
},
{
"name": "Data Export",
"key": "",
"status": "invalid"
},
{
"name": "Multi-Inventory",
"key": "XXXXXX",
"status": "valid"
},
{
"name": "Export Pro",
"key": "",
"status": "invalid"
}
]
Available parameters
| Parameter | Type | Description |
|---|---|---|
name |
string | Filter the results to only those matching the specified name. |
Dashboard
ATUM
The dashboard API allows you to get all types of ATUM Dashboard widgets available.
List all widgets
This API lets you retrieve and view a simple list of available widgets.
HTTP request
GET
/wp-json/wc/v3/atum/dashboard
curl https://example.com/wp-json/wc/v3/atum/dashboard \
-u consumer_key:consumer_secret
WooCommerce.get("atum/dashboard")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('atum/dashboard')); ?>
print(wcapi.get("atum/dashboard").json())
woocommerce.get("atum/dashboard").parsed_response
JSON response example:
[
{
"slug": "statistics",
"description": "Displays both: your earnings and product sales over time.",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/dashboard/statistics"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/dashboard"
}
]
}
},
{
"slug": "sales",
"description": "Displays all of your sales and number of products sold by day or month.",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/dashboard/sales"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/dashboard"
}
]
}
},
{
"slug": "lost-sales",
"description": "Displays all of your lost revenue and number of products not sold by day or month.",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/dashboard/lost-sales"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/dashboard"
}
]
}
},
{
"slug": "orders",
"description": "Displays all of your orders by day, week or month.",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/dashboard/orders"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/dashboard"
}
]
}
},
{
"slug": "promo-sales",
"description": "Displays all of your promo sales and number of promo products sold by day, week or month.",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/dashboard/promo-sales"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/dashboard"
}
]
}
},
{
"slug": "stock-control",
"description": "Displays the number of your products that are in stock, out of stock, running low and unmanaged.",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/dashboard/stock-control"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/dashboard"
}
]
}
},
{
"slug": "current-stock-value",
"description": "Displays the total quantity of items physically in stock (that have known purchase price) and their cumulated purchase value.",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/dashboard/current-stock-value"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/dashboard"
}
]
}
}
]
Retrieve statistics widget data
This API lets you retrieve and view the Dashboard's statistics widget data.
HTTP request
GET
/wp-json/wc/v3/atum/dasboard/statistics
curl https://example.com/wp-json/wc/v3/atum/dashboard/statistics?data=sales&period=this_year \
-u consumer_key:consumer_secret
WooCommerce.get("atum/dashboard/statistics", {
data: "sales",
period: "this_year"
})
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$query = [
'data' => 'sales',
'period' => 'this_year'
];
print_r($woocommerce->get('atum/dashboard/statistics', $query));
?>
print(wcapi.get("atum/dashboard/statistics?data=sales&period=this_year").json())
query = {
data: "sales",
period: "this_year"
}
woocommerce.get("atum/dashboard/statistics", query).parsed_response
JSON response example:
[
{
"dataset": {
"value": [
75,
838.7,
0,
643.7,
48,
0,
0,
0,
210,
102,
0
],
"products": [
6,
74,
0,
80,
4,
0,
0,
0,
9,
17,
0
]
},
"legends": {
"value": "Sales",
"products": "Products"
},
"period": "month",
"_links": {
"about": [
{
"href": "https://example.com/wp-json/wc/v3/atum/dashboard"
}
]
}
}
]
Statistics widget properties
| Attribute | Type | Description |
|---|---|---|
dataset |
object | The collection of data for the statistics. It contains value and products data. read-only |
period |
string | The period window used to get the statistics for. read-only |
legends |
object | The legends used on the statistics charts. read-only |
Available parameters
| Parameter | Type | Description |
|---|---|---|
data |
string | The type of data to return. Default is sales. Options: sales, lost-sales, promo-sales and orders. |
period |
string | The period to get statistics from. Default is this_year. Options: this_year, previous_year, this_month, previous_month, this_week and previous_week. |
Retrieve sales widget data
This API lets you retrieve and view the Dashboard's sales widget data.
HTTP request
GET
/wp-json/wc/v3/atum/dashboard/sales
curl https://example.com/wp-json/wc/v3/atum/dashboard/sales?period=month \
-u consumer_key:consumer_secret
WooCommerce.get("atum/dashboard/sales", {
period: "month"
})
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$query = [
'period' => 'month'
];
print_r($woocommerce->get('atum/dashboard/sales', $query));
?>
print(wcapi.get("atum/dashboard/sales?period=month").json())
query = {
period: "month"
}
woocommerce.get("atum/dashboard/sales", query).parsed_response
JSON response example:
[
{
"period": "month",
"data": {
"value": "€1590,00",
"products": 12
},
"_links": {
"about": [
{
"href": "https://example.com/wp-json/wc/v3/atum/dashboard"
}
]
}
}
]
Sales widget properties
| Attribute | Type | Description |
|---|---|---|
period |
string | The period window used to get the sales data for. read-only |
data |
object | The sales data. It contains value and products data. read-only |
Available parameters
| Parameter | Type | Description |
|---|---|---|
period |
string | The period to get sales data from. Default is today. Options: today and month |
Retrieve lost sales widget data
This API lets you retrieve and view the Dashboard's lost sales widget data.
HTTP request
GET
/wp-json/wc/v3/atum/dashboard/lost-sales
curl https://example.com/wp-json/wc/v3/atum/dashboard/lost-sales?period=month \
-u consumer_key:consumer_secret
WooCommerce.get("atum/dashboard/lost-sales", {
period: "month"
})
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$query = [
'period' => 'month'
];
print_r($woocommerce->get('atum/dashboard/lost-sales', $query));
?>
print(wcapi.get("atum/dashboard/lost-sales?period=month").json())
query = {
period: "month"
}
woocommerce.get("atum/dashboard/lost-sales", query).parsed_response
JSON response example:
[
{
"period": "month",
"data": {
"value": "€0,00",
"products": 12
},
"_links": {
"about": [
{
"href": "https://example.com/wp-json/wc/v3/atum/dashboard"
}
]
}
}
]
Lost sales widget properties
| Attribute | Type | Description |
|---|---|---|
period |
string | The period window used to get the lost sales data for. read-only |
data |
object | The lost sales data. It contains value and products data. read-only |
Available parameters
| Parameter | Type | Description |
|---|---|---|
period |
string | The period to get lost sales data from. Default is today. Options: today and month |
Retrieve orders widget data
This API lets you retrieve and view the Dashboard's orders widget data.
HTTP request
GET
/wp-json/wc/v3/atum/dashboard/orders
curl https://example.com/wp-json/wc/v3/atum/dashboard/orders?period=previous_month \
-u consumer_key:consumer_secret
WooCommerce.get("atum/dashboard/orders", {
period: "previous_month"
})
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$query = [
'period' => 'previous_month'
];
print_r($woocommerce->get('atum/dashboard/orders', $query));
?>
print(wcapi.get("atum/dashboard/orders?period=previous_month").json())
query = {
period: "previous_month"
}
woocommerce.get("atum/dashboard/orders", query).parsed_response
JSON response example:
[
{
"period": "previous_month",
"data": {
"value": "€16.121,98",
"orders": 137
},
"_links": {
"about": [
{
"href": "https://example.com/wp-json/wc/v3/atum/dashboard"
}
]
}
}
]
Orders widget properties
| Attribute | Type | Description |
|---|---|---|
period |
string | The period window used to get the orders data for. read-only |
data |
object | The orders data. It contains value and products data. read-only |
Available parameters
| Parameter | Type | Description |
|---|---|---|
period |
string | The period to get orders data from. Default is this_month. Options: this_month, previous_month, this_week and today. |
Retrieve promo sales widget data
This API lets you retrieve and view the Dashboard's promo sales widget data.
HTTP request
GET
/wp-json/wc/v3/atum/dashboard/promo-sales
curl https://example.com/wp-json/wc/v3/atum/dashboard/promo-sales?period=previous_month \
-u consumer_key:consumer_secret
WooCommerce.get("atum/dashboard/promo-sales", {
period: "previous_month"
})
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$query = [
'period' => 'previous_month'
];
print_r($woocommerce->get('atum/dashboard/promo-sales', $query));
?>
print(wcapi.get("atum/dashboard/promo-sales?period=previous_month").json())
query = {
period: "previous_month"
}
woocommerce.get("atum/dashboard/promo-sales", query).parsed_response
JSON response example:
[
{
"period": "previous_month",
"data": {
"value": "€2,00",
"products": 1
},
"_links": {
"about": [
{
"href": "https://example.com/wp-json/wc/v3/atum/dashboard"
}
]
}
}
]
Promo sales widget properties
| Attribute | Type | Description |
|---|---|---|
period |
string | The period window used to get the promo sales data for. read-only |
data |
object | The promo sales data. It contains value and products data. read-only |
Available parameters
| Parameter | Type | Description |
|---|---|---|
period |
string | The period to get promo sales data from. Default is this_month. Options: this_month, previous_month, this_week and today. |
Retrieve stock control widget data
This API lets you retrieve and view the Dashboard's stock control widget data.
HTTP request
GET
/wp-json/wc/v3/atum/dashboard/stock-control
curl https://example.com/wp-json/wc/v3/atum/dashboard/stock-control \
-u consumer_key:consumer_secret
WooCommerce.get("atum/dashboard/stock-control")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
print_r($woocommerce->get('atum/dashboard/stock-control'));
?>
print(wcapi.get("atum/dashboard/stock-control").json())
woocommerce.get("atum/dashboard/stock-control").parsed_response
JSON response example:
[
{
"stock_counters": {
"count_in_stock": 34,
"count_out_stock": 15,
"count_low_stock": 0,
"count_all": 68,
"count_unmanaged": 4
},
"_links": {
"about": [
{
"href": "https://example.com/wp-json/wc/v3/atum/dashboard"
}
]
}
}
]
Stock control widget properties
| Attribute | Type | Description |
|---|---|---|
stock_conuters |
object | The stock control data. It contains: count_in_stock, count_out_stock, count_low_stock, count_all and count_unmanaged. read-only |
Retrieve current stock value widget data
This API lets you retrieve and view the Dashboard's current stock value widget data.
HTTP request
GET
/wp-json/wc/v3/atum/dashboard/current-stock-value
curl https://example.com/wp-json/wc/v3/atum/dashboard/current-stock-value \
-u consumer_key:consumer_secret
WooCommerce.get("atum/dashboard/current-stock-value")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
print_r($woocommerce->get('atum/dashboard/current-stock-value'));
?>
print(wcapi.get("atum/dashboard/current-stock-value").json())
woocommerce.get("atum/dashboard/current-stock-value").parsed_response
JSON response example:
[
{
"current_stock_values": {
"items_stocks_counter": 31867,
"items_purchase_price_total": 59925.53,
"items_without_purchase_price": 7410
},
"_links": {
"about": [
{
"href": "https://example.com/wp-json/wc/v3/atum/dashboard"
}
]
}
}
]
Current stock value widget properties
| Attribute | Type | Description |
|---|---|---|
current_stock_values |
object | The current stock value data. It contains: items_stock_counter, items_purchase_price_total, and items_without_purchase_price. read-only |
Inbound stock
ATUM
The inbound stock API allows you to view the products that are set within pending purchase orders.
Inbound stock properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Unique identifier for the resource. read-only |
name |
string | Product name. read-only |
type |
string | Product type. Options: simple, grouped, external, variable, product-part, raw-material, variable-product-part and variable-raw-material. Default is simple. read-only |
sku |
string | Product's Stock Keeping Unit. read-only |
inbound_stock |
number | The quantity of the product set within the purchase order. read-only |
date_ordered |
date-time | The date when the Purchase Order was created, in the site's timezone. read-only |
date_ordered_gmt |
date-time | The date when the Purchase Order was created, as GMT. read-only |
date_expected |
date-time | The date when the Purchase Order is expected, in the site's timezone. read-only |
date_expected_gmt |
date-time | The date when the Purchase Order is expected, as GMT. read-only |
purchase_order |
integer | Unique identifier for the Purchase Order. read-only |
Retrieve an inbound product
This API lets you retrieve and view a the inbound stock for a specific product by ID.
HTTP request
GET
/wp-json/wc/v3/atum/inbound-stock/<id>
curl https://example.com/wp-json/wc/v3/atum/inbound-stock/175 \
-u consumer_key:consumer_secret
WooCommerce.get("atum/inbound-stock/175")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('atum/inbound-stock/175')); ?>
print(wcapi.get("atum/inbound-stock/175").json())
woocommerce.get("atum/inbound-stock/175").parsed_response
JSON response example:
[
{
"id": 175,
"name": "Product Part 1",
"type": "product-part",
"sku": "PART1",
"inbound_stock": 1,
"date_ordered": "2019-04-30T15:17:00",
"date_on_sale_from_gmt": "2019-04-30T13:17:00",
"date_expected": "2019-04-30T13:20:00",
"date_expected_gmt": "2019-04-30T11:20:00",
"purchase_order": 843,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inbound-stock/175"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inbound-stock"
}
]
}
},
{
"id": 175,
"name": "Product Part 1",
"type": "product-part",
"sku": "PART1",
"inbound_stock": 1,
"date_ordered": "2018-10-26T12:16:00",
"date_on_sale_from_gmt": "2018-10-26T10:16:00",
"date_expected": "2018-10-26T11:21:00",
"date_expected_gmt": "2018-10-26T09:21:00",
"purchase_order": 618,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inbound-stock/175"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inbound-stock"
}
]
}
}
]
List all inbound products
This API helps you to view all the inbound products.
HTTP request
GET
/wp-json/wc/v3/atum/inbound-stock
curl https://example.com/wp-json/wc/v3/atum/inbound-stock \
-u consumer_key:consumer_secret
WooCommerce.get("atum/inbound-stock")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('atum/inbound-stock')); ?>
print(wcapi.get("atum/inbound-stock").json())
woocommerce.get("atum/inbound-stock").parsed_response
JSON response example:
[
{
"id": 507,
"name": "ABC 123 XPTO",
"type": "simple",
"sku": "",
"inbound_stock": 5,
"date_ordered": "2019-10-24T10:16:12",
"date_on_sale_from_gmt": "2019-10-24T08:16:12",
"date_expected": "2019-11-11T09:55:31",
"date_expected_gmt": "2019-11-11T08:55:31",
"purchase_order": 1927,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inbound-stock/507"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inbound-stock"
}
]
}
},
{
"id": 23,
"name": "Ship Your Idea 2 - Black",
"type": "variation",
"sku": "",
"inbound_stock": 1,
"date_ordered": "2019-10-24T10:16:12",
"date_on_sale_from_gmt": "2019-10-24T08:16:12",
"date_expected": "2019-11-11T09:55:31",
"date_expected_gmt": "2019-11-11T08:55:31",
"purchase_order": 1927,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inbound-stock/23"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inbound-stock"
}
]
}
},
{
"id": 93,
"name": "Woo Single #1",
"type": "simple",
"sku": "Back Orders",
"inbound_stock": 2,
"date_ordered": "2019-10-04T11:35:00",
"date_on_sale_from_gmt": "2019-10-04T09:35:00",
"date_expected": "2019-10-05T10:00:00",
"date_expected_gmt": "2019-10-05T08:00:00",
"purchase_order": 1841,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inbound-stock/93"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inbound-stock"
}
]
}
},
{
"id": 23,
"name": "Ship Your Idea 2 - Black",
"type": "variation",
"sku": "",
"inbound_stock": 1,
"date_ordered": "2019-10-04T11:35:00",
"date_on_sale_from_gmt": "2019-10-04T09:35:00",
"date_expected": "2019-10-05T10:00:00",
"date_expected_gmt": "2019-10-05T08:00:00",
"purchase_order": 1841,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inbound-stock/23"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inbound-stock"
}
]
}
},
{
"id": 175,
"name": "Product Part 1",
"type": "product-part",
"sku": "PART1",
"inbound_stock": 1,
"date_ordered": "2019-04-30T15:17:00",
"date_on_sale_from_gmt": "2019-04-30T13:17:00",
"date_expected": "2019-04-30T13:20:00",
"date_expected_gmt": "2019-04-30T11:20:00",
"purchase_order": 843,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inbound-stock/175"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inbound-stock"
}
]
}
},
{
"id": 513,
"name": "Variable Product Part 1 - Black",
"type": "product-part-variation",
"sku": "VPART1",
"inbound_stock": 1,
"date_ordered": "2019-04-30T15:17:00",
"date_on_sale_from_gmt": "2019-04-30T13:17:00",
"date_expected": "2019-04-30T13:20:00",
"date_expected_gmt": "2019-04-30T11:20:00",
"purchase_order": 843,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inbound-stock/513"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inbound-stock"
}
]
}
},
{
"id": 507,
"name": "ABC 123 XPTO",
"type": "simple",
"sku": "",
"inbound_stock": 1,
"date_ordered": "2019-03-21T12:55:00",
"date_on_sale_from_gmt": "2019-03-21T11:55:00",
"date_expected": "2019-03-12T12:56:00",
"date_expected_gmt": "2019-03-12T11:56:00",
"purchase_order": 709,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inbound-stock/507"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inbound-stock"
}
]
}
},
{
"id": 90,
"name": "Woo Album #3",
"type": "simple",
"sku": "WOO3",
"inbound_stock": 1,
"date_ordered": "2019-03-11T09:35:00",
"date_on_sale_from_gmt": "2019-03-11T08:35:00",
"date_expected": "2019-03-11T09:36:00",
"date_expected_gmt": "2019-03-11T08:36:00",
"purchase_order": 701,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inbound-stock/90"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inbound-stock"
}
]
}
},
{
"id": 76,
"name": "Woo Ninja",
"type": "simple",
"sku": "",
"inbound_stock": 1,
"date_ordered": "2019-03-11T09:27:00",
"date_on_sale_from_gmt": "2019-03-11T08:27:00",
"date_expected": "2019-03-11T09:27:31",
"date_expected_gmt": "2019-03-11T08:27:31",
"purchase_order": 698,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inbound-stock/76"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inbound-stock"
}
]
}
}
]
Available parameters
| Parameter | Type | Description |
|---|---|---|
context |
string | Scope under which the request is made; determines fields present in response. Options: view and edit. Default is view. |
page |
integer | Current page of the collection. Default is 1. |
per_page |
integer | Maximum number of items to be returned in result set. Default is 10. |
search |
string | Limit results to those matching a string. |
after |
string | Limit response to resources published after a given ISO8601 compliant date. |
before |
string | Limit response to resources published before a given ISO8601 compliant date. |
exclude |
array | Ensure result set excludes specific IDs. |
include |
array | Limit result set to specific ids. |
offset |
integer | Offset the result set by a specific number of items. |
order |
string | Order sort attribute ascending or descending. Options: asc and desc. Default is desc. |
orderby |
string | Sort collection by object attribute. Options: date, id, include, title and slug. Default is date. |
include_po |
array | Limit result set to products with specified Purchase Order IDs. ATUM |
exclude_po |
array | Ensure result set excludes specific Purchasr Order IDs. ATUM |
expected_after |
string | Limit response to purchase orders expected after a given ISO8601 compliant date. ATUM |
expected_before |
string | Limit response to purchase orders expected before a given ISO8601 compliant date. ATUM |
Inventories
ATUM Multi-Inventory
The ATUM inventories API allows you to create, view, update, and delete inventories.
Inventory properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Unique identifier for the inventory. read-only |
product_id |
integer | The product ID this inventory is linked to. read-only |
name |
string | The inventory name. mandatory |
priority |
integer | The priority index within the list of the product inventories' list. |
is_main |
boolean | Whether the current inventory is the main inventory. |
inventory_date |
date-time | The date the inventory was created, as GMT. |
lot |
string | The LOT/BATCH number. |
write_off |
boolean | Number of published products for the resource. |
region |
array | If the region restriction mode is enabled, it'll show the list of countries or shipping zones linked to the inventory. |
location |
array | ATUM Location(s) linked to the inventory. |
bbe_date |
date-time | The Best-Before-Expiry date for the inventory, as GMT. |
expiry_days |
integer | The expiry days before the BBE date when the product should go out of stock. |
inbound_stock |
number | Inventory's inbound stock. read-only |
stock_on_hold |
number | Inventory's stock on hold. read-only |
sold_today |
number | Inventory units sold today. read-only |
sales_last_days |
number | Inventory sales the last 14 days. read-only |
reserved_stock |
number | Inventory stock set 'reserved_stock' within Inventory Logs. read-only |
customer_returns |
number | Inventory stock set as 'customer returns' within Inventory Logs. read-only |
warehouse_damage |
number | Stock set as 'warehouse damage' within Inventory Logs. read-only |
lost_in_post |
number | Stock set as 'lost in post' within Inventory Logs. read-only |
other_logs |
number | Stock set as 'other' within Inventory Logs. read-only |
out_stock_days |
integer | The number of days that the product is Out of stock. read-only |
lost_sales |
number | Product lost sales. read-only |
update_date |
date-time | Last date when the inventory data was calculated and saved for this product, as GMT. |
meta_data |
object | Meta data. See Inventories - Meta data properties |
Inventories - Meta data properties
| Attribute | Type | Description |
|---|---|---|
sku |
string | Inventory's SKU. |
manage_stock |
boolean | Whether the stock is being managed for the inventory. |
stock_quantity |
number | Inventory's stock amount. |
backorders |
boolean | Whether the back orders are allowed. |
stock_status |
string | Inventory's stock status. |
supplier_id |
integer | Inventoy supplier's ID. |
supplier_sku |
string | Inventory supplier's SKU. |
barcode |
string | Inventory barcode. |
out_stock_threshold |
number | Inventory's out of stock threshold. |
purchase_price |
number | Inventory's purchase price. |
price |
number | Inventory's price. |
regular_price |
number | Inventory's regular price. |
sale_price |
number | Inventory's sale price. |
date_on_sale_from |
date-time | The date when starts the sale price, as GMT. |
date_on_sale_to |
date-time | The date when ends the sale price, as GMT. |
out_stock_date |
date-time | The date when the inventory run out of stock, as GMT. |
Create an inventory
This API helps you to create a new inventory to the spedified product.
HTTP request
POST
/wp-json/wc/v3/products/<product_id>/inventories
Example of how to create a product inventory:
curl -X POST https://example.com/wp-json/wc/v3/products/507/inventories \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"name": "Inventory 1",
"is_main": false,
"meta_data": {
"sku": "TEST1",
"manage_stock": true,
"stock_quantity": 10,
"backorders": false,
"stock_status": "in_stock",
"purchase_price": 9.5,
"price": 12,
"regular_price": 12
}
}'
const data = {
name: 'Inventory 1',
is_main: false,
meta_data: {
sku: 'TEST1',
manage_stock: true,
stock_quantity: 10,
backorders: false,
stock_status: 'in_stock',
purchase_price: 9.5,
price: 12,
regular_price: 12
}
};
WooCommerce.post("products/507/inventories", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'name' => 'Inventory 1',
'is_main' => false,
'meta_data' => [
'sku' => 'TEST1',
'manage_stock' => true,
'stock_quantity' => 10,
'backorders' => false,
'stock_status' => 'in_stock',
'purchase_price' => 9.5,
'price' => 12,
'regular_price' => 12,
]
];
print_r($woocommerce->post('products/507/inventories', $data));
?>
data = {
"name": "Inventory 1",
"is_main": false,
"meta_data": {
"sku": "TEST1",
"manage_stock": true,
"stock_quantity": 10,
"backorders": false,
"stock_status": "in_stock",
"purchase_price": 9.5,
"price": 12,
"regular_price": 12
}
}
print(wcapi.post("products/507/inventories", data).json())
data = {
name: "Inventory 1",
is_main: false,
meta_data: {
sku: "TEST1",
manage_stock: true,
stock_quantity: 10,
backorders: false,
stock_status: "in_stock",
purchase_price: 9.5,
price: 12,
regular_price: 12
}
}
woocommerce.post("products/507/inventories", data).parsed_response
JSON response example:
{
"id": 208,
"product_id": 507,
"name": "Inventory 1",
"priority": 0,
"is_main": false,
"inventory_date": "2020-09-01T09:16:19",
"lot": "",
"write_off": false,
"region": "",
"location": [],
"bbe_date": null,
"expiry_days": 0,
"meta_data": {
"sku": "TEST1",
"manage_stock": true,
"stock_quantity": 10,
"backorders": "no",
"stock_status": "instock",
"supplier_id": "",
"supplier_sku": "",
"sold_individually": false,
"out_stock_threshold": "",
"purchase_price": "9.5",
"price": "12",
"regular_price": "12",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_to": null,
"out_stock_date": null
},
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/507/inventories/208"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/507/inventories"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/507"
}
]
}
}
Retrieve an inventory
This API lets you retrieve an inventory by ID.
GET
/wp-json/wc/v3/products/<product_id>/inventories/<inventory_id>
curl https://example.com/wp-json/wc/v3/products/507/inventories/208 \
-u consumer_key:consumer_secret
WooCommerce.get("products/507/inventories/208")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('products/507/inventories/208')); ?>
print(wcapi.get("products/507/inventories/208").json())
woocommerce.get("products/507/inventories/208").parsed_response
JSON response example:
{
"id": 208,
"product_id": 507,
"name": "Inventory 1",
"priority": 0,
"is_main": false,
"inventory_date": "2020-09-01T09:16:19",
"lot": "",
"write_off": false,
"region": "",
"location": [],
"bbe_date": null,
"expiry_days": 0,
"inbound_stock": "0",
"stock_on_hold": 0,
"sold_today": 0,
"sales_last_days": 0,
"reserved_stock": 0,
"customer_returns": 0,
"warehouse_damage": 0,
"lost_in_post": 0,
"other_logs": 0,
"out_stock_days": 0,
"lost_sales": 0,
"update_date": "2020-09-01T09:16:19",
"meta_data": {
"sku": "TEST1",
"manage_stock": true,
"stock_quantity": 10,
"backorders": "no",
"stock_status": "instock",
"supplier_id": "",
"supplier_sku": "",
"barcode": "",
"sold_individually": false,
"out_stock_threshold": "",
"purchase_price": "9.5",
"price": "12",
"regular_price": "12",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_to": null,
"out_stock_date": null
},
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/507/inventories/208"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/507/inventories"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/507"
}
]
}
}
List all the product inventories
This API lets you retrieve all the inventories for the specified product.
GET
/wp-json/wc/v3/products/507/inventories
curl https://example.com/wp-json/wc/v3/products/507/inventories \
-u consumer_key:consumer_secret
WooCommerce.get("products/507/inventories")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('products/507/inventories')); ?>
print(wcapi.get("products/507/inventories").json())
woocommerce.get("products/507/inventories").parsed_response
JSON response example:
[
{
"id": "55",
"product_id": 507,
"name": "Main Inventory",
"priority": 0,
"is_main": true,
"inventory_date": "2019-09-11T10:26:00",
"lot": "",
"write_off": false,
"region": "",
"location": {
"50": "madrid"
},
"bbe_date": null,
"expiry_days": 0,
"inbound_stock": "1",
"stock_on_hold": 4,
"sold_today": 0,
"sales_last_days": 0,
"reserved_stock": 1,
"customer_returns": 0,
"warehouse_damage": 0,
"lost_in_post": 0,
"other_logs": 0,
"out_stock_days": 0,
"lost_sales": 0,
"update_date": "2020-08-31T07:27:30",
"meta_data": {
"sku": "",
"manage_stock": true,
"stock_quantity": 22,
"backorders": "no",
"stock_status": "instock",
"supplier_id": 399,
"supplier_sku": "CRYPTO",
"barcode": "INVBARKJHOIHO",
"sold_individually": false,
"out_stock_threshold": "",
"purchase_price": "2",
"price": "5.32",
"regular_price": "5.32",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_to": null,
"out_stock_date": null
},
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/507/inventories/55"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/507/inventories"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/507"
}
]
}
},
{
"id": "208",
"product_id": 507,
"name": "Inventory 1",
"priority": 0,
"is_main": false,
"inventory_date": "2020-09-01T09:16:19",
"lot": "",
"write_off": false,
"region": "",
"location": [],
"bbe_date": null,
"expiry_days": 0,
"inbound_stock": "0",
"stock_on_hold": 0,
"sold_today": 0,
"sales_last_days": 0,
"reserved_stock": 0,
"customer_returns": 0,
"warehouse_damage": 0,
"lost_in_post": 0,
"other_logs": 0,
"out_stock_days": 0,
"lost_sales": 0,
"update_date": "2020-09-01T09:16:19",
"meta_data": {
"sku": "TEST1",
"manage_stock": true,
"stock_quantity": 10,
"backorders": "no",
"stock_status": "instock",
"supplier_id": "",
"supplier_sku": "",
"barcode": "",
"sold_individually": false,
"out_stock_threshold": "",
"purchase_price": "9.5",
"price": "12",
"regular_price": "12",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_to": null,
"out_stock_date": null
},
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/507/inventories/208"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/507/inventories"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/507"
}
]
}
}
]
Available parameters
| Parameter | Type | Description |
|---|---|---|
after |
string | Limit response to resources created after a given ISO8601 compliant date. |
before |
string | Limit response to resources created before a given ISO8601 compliant date. |
exclude |
array | Ensure result set excludes specific IDs. |
include |
array | Limit result set excludes specific IDs. |
offset |
integer | Offset the result set by a specific number of items. |
order |
string | Order sort attribute ascending or descending. Options: asc and desc. Default is asc. |
orderby |
string | Sort collection by object attribute. Options: priority, inventory_date, id, name and bbe_date. Default is priority. |
name |
string | Limit result set to inventories with a specific name. |
exclude_write_off |
boolean | Exclude from result set the inventories that were marked as 'write off'. Default is true. |
lot |
string | Limit result set to inventories with the specified LOT/BATCH number. |
barcode |
string | Limit result set to inventories with the specified barcode. |
countries |
string | If the country restriction mode is enabled, limit the result set to inventories linked to the specified country. |
shipping_zone |
string | If the shipping zone restriction mode is enabled, limit the result set to inventories linked to the specified shipping zone. |
location |
string | Limit the result set to inventories linked to the specified location ID or slug. |
List all the inventories
This API lets you retrieve all the inventories registered on the system.
GET
/wp-json/wc/v3/atum/inventories
curl https://example.com/wp-json/wc/v3/atum/inventories \
-u consumer_key:consumer_secret
WooCommerce.get("atum/inventories")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('atum/inventories')); ?>
print(wcapi.get("atum/inventories").json())
woocommerce.get("atum/inventories").parsed_response
JSON response example:
[
{
"id": "3",
"product_id": 90,
"name": "Custom Inventory",
"priority": 5,
"is_main": false,
"inventory_date": "2018-10-25T10:10:00",
"lot": "",
"write_off": false,
"region": "",
"location": [],
"bbe_date": null,
"expiry_days": 0,
"inbound_stock": "0",
"stock_on_hold": 17,
"sold_today": 0,
"sales_last_days": 0,
"reserved_stock": 0,
"customer_returns": 0,
"warehouse_damage": 0,
"lost_in_post": 0,
"other_logs": 0,
"out_stock_days": 0,
"lost_sales": 0,
"update_date": "2020-10-05T07:20:52",
"meta_data": {
"sku": "WOO3",
"manage_stock": true,
"stock_quantity": 3,
"backorders": "no",
"stock_status": "instock",
"supplier_id": 399,
"supplier_sku": "SUPSK1",
"barcode": "AAAAAABBBBBB",
"sold_individually": false,
"out_stock_threshold": "",
"purchase_price": "18.9",
"price": "15.7",
"regular_price": "15.7",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_to": null,
"out_stock_date": null,
"expired_stock": null
},
"_links": {
"self": [
{
"href": "http://example.com/wp-json/wc/v3/products/90/inventories/3"
}
],
"collection": [
{
"href": "http://example.com/wp-json/wc/v3/products/90/inventories"
}
],
"up": [
{
"href": "http://example.com/wp-json/wc/v3/products/90"
}
]
}
},
{
"id": "7",
"product_id": 83,
"name": "Main Inventory",
"priority": 0,
"is_main": true,
"inventory_date": "2018-10-25T10:10:24",
"lot": "",
"write_off": false,
"region": "",
"location": [],
"bbe_date": "-0001-11-30T00:00:00",
"expiry_days": 0,
"inbound_stock": "0",
"stock_on_hold": 0,
"sold_today": 0,
"sales_last_days": 0,
"reserved_stock": 0,
"customer_returns": 0,
"warehouse_damage": 0,
"lost_in_post": 0,
"other_logs": 0,
"out_stock_days": 108,
"lost_sales": 0,
"update_date": "2020-10-05T07:20:53",
"meta_data": {
"sku": "",
"manage_stock": true,
"stock_quantity": 0,
"backorders": "no",
"stock_status": "instock",
"supplier_id": "",
"supplier_sku": "",
"barcode": "",
"sold_individually": false,
"out_stock_threshold": 0,
"purchase_price": "128",
"price": "9",
"regular_price": "9",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_to": null,
"out_stock_date": "2020-06-18T09:08:57",
"expired_stock": null
},
"_links": {
"self": [
{
"href": "http://example.com/wp-json/wc/v3/products/83/inventories/7"
}
],
"collection": [
{
"href": "http://example.com/wp-json/wc/v3/products/83/inventories"
}
],
"up": [
{
"href": "http://example.com/wp-json/wc/v3/products/83"
}
]
}
},
{
"id": "10",
"product_id": 37,
"name": "Main Inventory",
"priority": 0,
"is_main": true,
"inventory_date": "2018-06-06T10:14:00",
"lot": "123456",
"write_off": false,
"region": "",
"location": [],
"bbe_date": null,
"expiry_days": 0,
"inbound_stock": "0",
"stock_on_hold": 0,
"sold_today": 0,
"sales_last_days": 0,
"reserved_stock": 0,
"customer_returns": 0,
"warehouse_damage": 1,
"lost_in_post": 0,
"other_logs": 0,
"out_stock_days": 0,
"lost_sales": 0,
"update_date": "2020-06-04T06:20:29",
"meta_data": {
"sku": "",
"manage_stock": true,
"stock_quantity": 2,
"backorders": "no",
"stock_status": "instock",
"supplier_id": "",
"supplier_sku": "",
"barcode": "",
"sold_individually": false,
"out_stock_threshold": "",
"purchase_price": "5",
"price": "12",
"regular_price": "12",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_to": null,
"out_stock_date": null,
"expired_stock": null
},
"_links": {
"self": [
{
"href": "http://example.com/wp-json/wc/v3/products/37/inventories/10"
}
],
"collection": [
{
"href": "http://example.com/wp-json/wc/v3/products/37/inventories"
}
],
"up": [
{
"href": "http://example.com/wp-json/wc/v3/products/37"
}
]
}
}
]
Available parameters
| Parameter | Type | Description |
|---|---|---|
after |
string | Limit response to resources created after a given ISO8601 compliant date. |
before |
string | Limit response to resources created before a given ISO8601 compliant date. |
exclude |
array | Ensure result set excludes specific IDs. |
include |
array | Limit result set excludes specific IDs. |
offset |
integer | Offset the result set by a specific number of items. |
page |
integer | Current page of the collection. Default is 1. |
per_page |
integer | Maximum number of items to be returned in result set. Default is 10. |
order |
string | Order sort attribute ascending or descending. Options: asc and desc. Default is asc. |
orderby |
string | Sort collection by object attribute. Options: priority, inventory_date, id, name and bbe_date. Default is id. |
name |
string | Limit result set to inventories with a specific name. |
exclude_write_off |
boolean | Exclude from result set the inventories that were marked as 'write off'. Default is true. |
lot |
string | Limit result set to inventories with the specified LOT/BATCH number. |
barcode |
string | Limit result set to inventories with the specified barcode. |
countries |
string | If the country restriction mode is enabled, limit the result set to inventories linked to the specified country. |
shipping_zone |
string | If the shipping zone restriction mode is enabled, limit the result set to inventories linked to the specified shipping zone. |
location |
string | Limit the result set to inventories linked to the specified location ID or slug. |
product |
integer | Filter the results by the specified product ID. |
search |
string | Limit results to those matching a string. |
Update an inventory
This API lets you make changes to a product inventory.
HTTP request
PUT
/wp-json/wc/v3/products/<product_id>/inventories/<inventory_id>
curl -X PUT https://example.com/wp-json/wc/v3/products/507/inventories/208 \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"meta_data": {
"stock_quantity": 200
}
}'
const data = {
meta_data: {
stock_quantity: 200
}
};
WooCommerce.put("products/507/inventories/208", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'meta_data' => [
'stock_quantity' => 200,
]
];
print_r($woocommerce->put('products/507/inventories/208', $data));
?>
data = {
"meta_data": {
"stock_quantity": 200
}
}
print(wcapi.put("products/507/inventories/208", data).json())
data = {
meta_data: {
stock_quantity: 200
}
}
woocommerce.put("products/507/inventories/208", data).parsed_response
JSON response example:
{
"id": 208,
"product_id": 507,
"name": "Inventory 1",
"priority": 0,
"is_main": false,
"inventory_date": "2020-09-01T09:16:19",
"lot": "",
"write_off": false,
"region": "",
"location": [],
"bbe_date": null,
"expiry_days": 0,
"meta_data": {
"sku": "TEST1",
"manage_stock": true,
"stock_quantity": 200,
"backorders": "no",
"stock_status": "instock",
"supplier_id": "",
"supplier_sku": "",
"barcode": "",
"sold_individually": false,
"out_stock_threshold": "",
"purchase_price": "9.5",
"price": "12",
"regular_price": "12",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_to": null,
"out_stock_date": null
},
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/507/inventories/208"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/507/inventories"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/507"
}
]
}
}
Delete a product inventory
This API helps you delete a product inventory.
HTTP request
DELETE
/wp-json/wc/v3/products/<product_id>/inventories/<inventory_id>
curl -X DELETE https://example.com/wp-json/wc/v3/products/507/inventories/208?force=true \
-u consumer_key:consumer_secret
WooCommerce.delete("products/507/inventories/208", {
force: true
})
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->delete('products/507/inventories/208', ['force' => true])); ?>
print(wcapi.delete("products/507/inventories/208", params={"force": True}).json())
woocommerce.delete("products/507/inventories/208", force: true).parsed_response
JSON response example:
{
"id": 208,
"product_id": 507,
"name": "Inventory 1",
"priority": 0,
"is_main": false,
"inventory_date": "2020-09-01T09:16:19",
"lot": "",
"write_off": false,
"region": "",
"location": [],
"bbe_date": null,
"expiry_days": 0,
"meta_data": {
"sku": "TEST1",
"manage_stock": true,
"stock_quantity": 200,
"backorders": "no",
"stock_status": "instock",
"supplier_id": "",
"supplier_sku": "",
"barcode": "",
"sold_individually": false,
"out_stock_threshold": "",
"purchase_price": "9.5",
"price": "12",
"regular_price": "12",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_to": null,
"out_stock_date": null
},
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/507/inventories/208"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/507/inventories"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/507"
}
]
}
}
Available parameters
| Parameter | Type | Description |
|---|---|---|
force |
string | Required to be true, as resource does not support trashing. |
Batch update product inventories
This API helps you to batch create, update and delete multiple product inventories.
HTTP request
POST
/wp-json/wc/v3/products/<product_id>/inventories/batch
curl -X POST https://example.com/wp-json/wc/v3/products/507/inventories/batch \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"create": [
{
"name": "TEST Batch Inventory",
"is_main": false
}
],
"update": [
{
"id": 152,
"meta_data": {
"manage_stock": true,
"stock_quantity": 20
}
}
],
"delete": [ 210, 211 ]
}'
const data = {
create: [
{
name: 'TEST Batch Inventory',
is_main: false
}
],
update: [
{
id: 152,
meta_data: {
manage_stock: true,
stock_quantity: 20
}
}
],
delete: [ 210, 211 ]
};
WooCommerce.post("products/507/inventories/batch", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'create' => [
[
'name' => 'TEST Batch Inventory',
'is_main' => false
],
],
'update' => [
[
'id' => 152,
'meta_data' => [
'manage_stock' => true,
'stock_quantity' => 20
],
],
],
'delete' => [
210, 211
]
];
print_r($woocommerce->post('products/507/inventories/batch', $data));
?>
data = {
"create": [
{
"name": "TEST Batch Inventory",
"is_main": false
}
],
"update": [
{
"id": 152,
"meta_data": {
"manage_stock": true,
"stock_quantity": 20
}
}
],
"delete": [ 210, 211 ]
}
print(wcapi.post("products/507/inventories/batch", data).json())
data = {
create: [
{
name: "TEST Batch Inventory",
is_main: false
}
],
update: [
{
id: 152,
meta_data: {
manage_stock: true,
stock_quantity: 20
}
}
],
delete: [ 210, 211 ]
}
woocommerce.post("products/507/inventories/batch", data).parsed_response
JSON response example:
{
"create": [
{
"id": 212,
"product_id": 507,
"name": "TEST Batch Inventory",
"priority": 0,
"is_main": false,
"inventory_date": "2020-09-01T11:11:31",
"lot": "",
"write_off": false,
"region": "",
"location": [],
"bbe_date": null,
"expiry_days": 0,
"meta_data": {
"sku": "",
"manage_stock": false,
"stock_quantity": null,
"backorders": "no",
"stock_status": "",
"supplier_id": "",
"supplier_sku": "",
"barcode": "",
"sold_individually": false,
"out_stock_threshold": "",
"purchase_price": "",
"price": "",
"regular_price": "",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_to": null,
"out_stock_date": null
},
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/507/inventories/212"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/507/inventories"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/507"
}
]
}
}
],
"update": [
{
"id": 152,
"product_id": 507,
"name": "TEST Batch Inventory",
"priority": 1,
"is_main": false,
"inventory_date": "2019-06-11T10:08:00",
"lot": "",
"write_off": false,
"region": "",
"location": {
"53": "slovakia",
"49": "valencia"
},
"bbe_date": null,
"expiry_days": 0,
"meta_data": {
"sku": "",
"manage_stock": true,
"stock_quantity": 20,
"backorders": "no",
"stock_status": "instock",
"supplier_id": "",
"supplier_sku": "",
"barcode": "",
"sold_individually": false,
"out_stock_threshold": "",
"purchase_price": "5",
"price": "20",
"regular_price": "20",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_to": null,
"out_stock_date": null
},
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/507/inventories/152"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/507/inventories"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/507"
}
]
}
}
],
"delete": [
{
"id": 210,
"product_id": 507,
"name": "TEST Batch Inventory",
"priority": 0,
"is_main": false,
"inventory_date": "2020-09-01T11:10:02",
"lot": "",
"write_off": false,
"region": "",
"location": [],
"bbe_date": null,
"expiry_days": 0,
"meta_data": {
"sku": "",
"manage_stock": false,
"stock_quantity": null,
"backorders": "no",
"stock_status": "",
"supplier_id": "",
"supplier_sku": "",
"barcode": "",
"sold_individually": false,
"out_stock_threshold": "",
"purchase_price": "",
"price": "",
"regular_price": "",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_to": null,
"out_stock_date": null
},
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/507/inventories/210"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/507/inventories"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/507"
}
]
}
},
{
"id": 211,
"product_id": 507,
"name": "TEST Batch Inventory",
"priority": 0,
"is_main": false,
"inventory_date": "2020-09-01T11:10:05",
"lot": "",
"write_off": false,
"region": "",
"location": [],
"bbe_date": null,
"expiry_days": 0,
"meta_data": {
"sku": "",
"manage_stock": false,
"stock_quantity": null,
"backorders": "no",
"stock_status": "",
"supplier_id": "",
"supplier_sku": "",
"barcode": "",
"sold_individually": false,
"out_stock_threshold": "",
"purchase_price": "",
"price": "",
"regular_price": "",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_to": null,
"out_stock_date": null
},
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/507/inventories/211"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/507/inventories"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/507"
}
]
}
}
]
}
Batch update All inventories
This API helps you to batch create, update and delete multiple inventories at once and also mixing inventories from distinct products at the same time.
HTTP request
POST
/wp-json/wc/v3/atum/inventories/batch
curl -X POST https://example.com/wp-json/wc/v3/atum/inventories/batch \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"create": [
{
"product_id": 2123,
"name": "TEST Batch Inventory",
"is_main": false
}
],
"update": [
{
"id": 152,
"meta_data": {
"manage_stock": true,
"stock_quantity": 20
}
}
],
"delete": [ 210, 211 ]
}'
const data = {
create: [
{
product_id: 2123,
name: 'TEST Batch Inventory',
is_main: false
}
],
update: [
{
id: 152,
meta_data: {
manage_stock: true,
stock_quantity: 20
}
}
],
delete: [ 210, 211 ]
};
WooCommerce.post("atum/inventories/batch", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'create' => [
[
'product_id' => 2123,
'name' => 'TEST Batch Inventory',
'is_main' => false
],
],
'update' => [
[
'id' => 152,
'meta_data' => [
'manage_stock' => true,
'stock_quantity' => 20
],
],
],
'delete' => [
210, 211
]
];
print_r($woocommerce->post('atum/inventories/batch', $data));
?>
data = {
"create": [
{
"product_id": 2123,
"name": "TEST Batch Inventory",
"is_main": false
}
],
"update": [
{
"id": 152,
"meta_data": {
"manage_stock": true,
"stock_quantity": 20
}
}
],
"delete": [ 210, 211 ]
}
print(wcapi.post("atum/inventories/batch", data).json())
data = {
create: [
{
product_id: 2123,
name: "TEST Batch Inventory",
is_main: false
}
],
update: [
{
id: 152,
meta_data: {
manage_stock: true,
stock_quantity: 20
}
}
],
delete: [ 210, 211 ]
}
woocommerce.post("atum/inventories/batch", data).parsed_response
JSON response example:
{
"create": [
{
"id": 212,
"product_id": 507,
"name": "TEST Batch Inventory",
"priority": 0,
"is_main": false,
"inventory_date": "2020-09-01T11:11:31",
"lot": "",
"write_off": false,
"region": "",
"location": [],
"bbe_date": null,
"expiry_days": 0,
"meta_data": {
"sku": "",
"manage_stock": false,
"stock_quantity": null,
"backorders": "no",
"stock_status": "",
"supplier_id": "",
"supplier_sku": "",
"barcode": "",
"sold_individually": false,
"out_stock_threshold": "",
"purchase_price": "",
"price": "",
"regular_price": "",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_to": null,
"out_stock_date": null
},
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/507/inventories/212"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/507/inventories"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/507"
}
]
}
}
],
"update": [
{
"id": 152,
"product_id": 507,
"name": "TEST Batch Inventory",
"priority": 1,
"is_main": false,
"inventory_date": "2019-06-11T10:08:00",
"lot": "",
"write_off": false,
"region": "",
"location": {
"53": "slovakia",
"49": "valencia"
},
"bbe_date": null,
"expiry_days": 0,
"meta_data": {
"sku": "",
"manage_stock": true,
"stock_quantity": 20,
"backorders": "no",
"stock_status": "instock",
"supplier_id": "",
"supplier_sku": "",
"barcode": "",
"sold_individually": false,
"out_stock_threshold": "",
"purchase_price": "5",
"price": "20",
"regular_price": "20",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_to": null,
"out_stock_date": null
},
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/507/inventories/152"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/507/inventories"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/507"
}
]
}
}
],
"delete": [
{
"id": 210,
"product_id": 507,
"name": "TEST Batch Inventory",
"priority": 0,
"is_main": false,
"inventory_date": "2020-09-01T11:10:02",
"lot": "",
"write_off": false,
"region": "",
"location": [],
"bbe_date": null,
"expiry_days": 0,
"meta_data": {
"sku": "",
"manage_stock": false,
"stock_quantity": null,
"backorders": "no",
"stock_status": "",
"supplier_id": "",
"supplier_sku": "",
"barcode": "",
"sold_individually": false,
"out_stock_threshold": "",
"purchase_price": "",
"price": "",
"regular_price": "",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_to": null,
"out_stock_date": null
},
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/507/inventories/210"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/507/inventories"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/507"
}
]
}
},
{
"id": 211,
"product_id": 507,
"name": "TEST Batch Inventory",
"priority": 0,
"is_main": false,
"inventory_date": "2020-09-01T11:10:05",
"lot": "",
"write_off": false,
"region": "",
"location": [],
"bbe_date": null,
"expiry_days": 0,
"meta_data": {
"sku": "",
"manage_stock": false,
"stock_quantity": null,
"backorders": "no",
"stock_status": "",
"supplier_id": "",
"supplier_sku": "",
"barcode": "",
"sold_individually": false,
"out_stock_threshold": "",
"purchase_price": "",
"price": "",
"regular_price": "",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_to": null,
"out_stock_date": null
},
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/507/inventories/211"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/507/inventories"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/507"
}
]
}
}
]
}
Inventory logs
ATUM
The inventory logs API allows you to create, view, update, and delete individual, or a batch, of inventory logs.
Inventory log properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Unique identifier for the resource. read-only |
status |
string | Inventory log status. Options: atum_pending, atum_completed and trash. |
currency |
string | Currency the inventory log was created with, in ISO format. Options: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTC, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, IRT, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PRB, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR and ZMW. Default is USD. |
date_created |
date-time | The date the inventory log was created, in the site's timezone. |
date_created_gmt |
date-time | The date the inventory log was created, as GMT. |
date_modified |
date-time | The date the inventory log was last modified, in the site's timezone. read-only |
date_modified_gmt |
date-time | The date the inventory log was last modified, as GMT. read-only |
discount_total |
string | Total discount amount for the inventory log. read-only |
discount_tax |
string | Total discount tax amount for the inventory log. read-only |
shipping_total |
string | Total shipping amount for the inventory log. read-only |
shipping_tax |
string | Total shipping tax amount for the inventory log. read-only |
cart_tax |
string | Sum of line item taxes only. read-only |
total |
string | Grand total. read-only |
total_tax |
string | Sum of all taxes. read-only |
prices_include_tax |
boolean | True the prices included tax during checkout. read-only |
date_completed |
date-time | The date the inventory log was completed, in the site's timezone. |
date_completed_gmt |
date-time | The date the inventory log was completed, as GMT. |
type |
string | The log type. Options: reserved-stock, customer-returns, warehouse-damage, lost-in-post, other. |
order |
integer | The WooCommerce's order ID to which this Log is linked to. |
reservation_date |
date-time | The date for when the stock is reserved, in the site's timezone. Only for IL with type reserved-stock. |
reservation_date_gmt |
date-time | The date for when the stock is reserved, as GMT. Only for IL with type reserved-stock. |
return_date |
date-time | The date for when the customer returned the stock, in the site's timezone. Only for IL with type customer-returns. |
return_date_gmt |
date-time | The date for when the customer returned the stock, as GMT. Only for IL with type customer-returns. |
damage_date |
date-time | The date for when the stock was damaged at warehouse, in the site's timezone. Only for IL with type warehouse-damage. |
damage_date_gmt |
date-time | The date for when the stock was damaged at warehouse, as GMT. Only for IL with type warehouse-damage. |
shipping_company |
string | The name of the company that lost in post. Only for IL with type lost-in-post. |
custom_name |
string | The custom name for the 'other' log types. Only for IL with type other. |
meta_data |
array | Meta data. See Inventory Log - Meta data properties |
line_items |
array | Line items data. See Inventory Log - Line items properties |
tax_lines |
array | Tax lines data. See Inventory Log - Tax lines properties read-only |
shipping_lines |
array | Shipping lines data. See Inventory Log - Shipping lines properties |
fee_lines |
array | Fee lines data. See Inventory Log - Fee lines properties |
meta_data |
array | Meta data. See Inventory Log - Meta data properties |
description |
string | The inventory log description. |
Inventory Log - Meta data properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Meta ID. read-only |
key |
string | Meta key. |
value |
string | Meta value. |
Inventory Log - Line items properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Item ID. read-only |
name |
string | Product name. |
product_id |
integer | Product ID. |
variation_id |
integer | Variation ID, if applicable. |
quantity |
integer | Quantity ordered. |
tax_class |
string | Slug of the tax class of product. |
subtotal |
string | Line subtotal (before discounts). |
subtotal_tax |
string | Line subtotal tax (before discounts). read-only |
total |
string | Line total (after discounts). |
total_tax |
string | Line total tax (after discounts). read-only |
taxes |
array | Line taxes. See Inventory Log - Taxes properties read-only |
stock_changed |
string | Whether the stock was already changed for this item. Options: yes and no. |
meta_data |
array | Meta data. See Inventory Log - Meta data properties |
sku |
string | Product SKU. read-only |
price |
string | Product price. read-only |
mi_inventories |
array | Multi-Inventory order items. See Inventory Log - MI Order Items properties Multi-Inventory |
bom_items |
array | BOM order items. See Inventory Log - BOM Order Items properties read-only Product Levels |
Inventory Log - Tax lines properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Item ID. read-only |
rate_code |
string | Tax rate code. read-only |
rate_id |
string | Tax rate ID. read-only |
label |
string | Tax rate label. read-only |
compound |
boolean | Show if is a compound tax rate. read-only |
tax_total |
string | Tax total (not including shipping taxes). read-only |
shipping_tax_total |
string | Shipping tax total. read-only |
meta_data |
array | Meta data. See Inventory Log - Meta data properties |
Inventory Log - Shipping lines properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Item ID. read-only |
method_title |
string | Shipping method name. |
method_id |
string | Shipping method ID. |
total |
string | Line total (after discounts). |
total_tax |
string | Line total tax (after discounts). read-only |
taxes |
array | Line taxes. See Inventory Log - Taxes properties read-only |
meta_data |
array | Meta data. See Inventory Log - Meta data properties |
Inventory Log - Fee lines properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Item ID. read-only |
name |
string | Fee name. |
tax_class |
string | Tax class of fee. |
tax_status |
string | Tax status of fee. Options: taxable and none. |
total |
string | Line total (after discounts). |
total_tax |
string | Line total tax (after discounts). read-only |
taxes |
array | Line taxes. See Inventory Log - Taxes properties read-only |
meta_data |
array | Meta data. See Inventory Log - Meta data properties |
Inventory Log - Taxes properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Item ID. read-only |
rate_code |
string | Tax rate code. read-only |
rate_id |
string | Tax rate ID. read-only |
label |
string | Tax rate label. read-only |
compound |
boolean | Show if is a compound tax rate. read-only |
tax_total |
string | Tax total (not including shipping taxes). read-only |
shipping_tax_total |
string | Shipping tax total. read-only |
meta_data |
array | Meta data. See Inventory Log - Meta data properties |
Inventory Log - MI Order Items properties Multi-Inventory
| Attribute | Type | Description |
|---|---|---|
id |
integer | The order item inventory ID. |
delete |
boolean | Set to true to delete the order item inventory with the specified inventory ID. write-only |
order_item_id |
integer | The order item ID linked to this order item inventory. |
inventory_id |
integer | The inventory ID linked to the order item. |
product_id |
integer | The product ID from where the inventory comes. |
qty |
number | The quantity of the specified inventory that is used on the order item. |
order_type |
integer | The type of order (WC Order = 1, Purchase Order = 2, Inventory Log = 3). |
subtotal |
number | Order item inventory's subtotal. |
total |
number | Order item inventory's total. |
refund_qty |
number | Order item inventory's refund quantity. |
refund_total |
number | Order item inventory's refund total. |
Inventory Log - BOM Order Items properties Product Levels
| Attribute | Type | Description |
|---|---|---|
id |
integer | The BOM order item ID. read-only |
bom_id |
integer | The BOM product ID associated to the BOM order item. read-only |
bom_type |
string | The BOM product type. Options: product_part and raw_material. read-only |
qty |
number | The quantity of the specified BOM that is used on the order item. read-only |
Create an inventory log
This API helps you to create a new inventory log.
HTTP request
POST
/wp-json/wc/v3/atum/inventory-logs
curl -X POST https://example.com/wp-json/wc/v3/atum/inventory-logs \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"type": "reserved-stock",
"reservation_date": "2019-11-11T11:26:41",
"description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
"status": "atum_pending",
"line_items": [
{
"product_id": 93,
"quantity": 2,
"mi_inventories": [
{
"inventory_id": 152,
"qty": 1
},
{
"inventory_id": 126,
"qty": 1
}
]
},
{
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 112,
"qty": 1
}
]
}
],
"shipping_lines": [
{
"method_id": "flat_rate",
"method_title": "Flat Rate",
"total": "10"
}
]
}'
const data = {
type: "reserved-stock",
reservation_date: "2019-11-11T11:26:41",
description: "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
status: "atum_pending",
line_items: [
{
product_id: 93,
quantity: 2,
mi_inventories: [
{
inventory_id: 152,
qty: 1
},
{
inventory_id: 126,
qty: 1
}
]
},
{
product_id: 22,
variation_id: 23,
quantity: 1,
mi_inventories: [
{
inventory_id: 112,
qty: 1
}
]
}
],
shipping_lines: [
{
method_id: "flat_rate",
method_title: "Flat Rate",
total: "10"
}
]
};
WooCommerce.post("atum/inventory-logs", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'type' => 'reserved-stock',
'reservation_date' => '2019-11-11T11:26:41',
'description' => 'Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.',
'status' => 'atum_pending',
'line_items' => [
[
'product_id' => 93,
'quantity' => 2,
'mi_inventories' => [
[
'inventory_id' => 152,
'qty' => 1
],
[
'inventory_id' => 126,
'qty' => 1
]
]
],
[
'product_id' => 22,
'variation_id' => 23,
'quantity' => 1,
'mi_inventories' => [
[
'inventory_id' => 112,
'qty' => 1
]
]
]
],
'shipping_lines' => [
[
'method_id' => 'flat_rate',
'method_title' => 'Flat Rate',
'total' => '10'
]
]
];
print_r($woocommerce->post('atum/inventory-logs', $data));
?>
data = {
"type": "reserved-stock",
"reservation_date": "2019-11-11T11:26:41",
"description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
"status": "atum_pending",
"line_items": [
{
"product_id": 93,
"quantity": 2,
"mi_inventories": [
{
"inventory_id": 152,
"qty": 1
},
{
"inventory_id": 126,
"qty": 1
}
]
},
{
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 112,
"qty": 1
}
]
}
],
"shipping_lines": [
{
"method_id": "flat_rate",
"method_title": "Flat Rate",
"total": "10"
}
]
}
print(wcapi.post("atum/inventory-logs", data).json())
data = {
type: "reserved-stock",
reservation_date: "2019-11-11T11:26:41",
description: "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
status: "atum_pending",
line_items: [
{
product_id: 93,
quantity: 2,
mi_inventories: [
{
inventory_id: 152,
qty: 1
},
{
inventory_id: 126,
qty: 1
}
]
},
{
product_id: 22,
variation_id: 23,
quantity: 1,
mi_inventories: [
{
inventory_id: 112,
qty: 1
}
]
}
],
shipping_lines: [
{
method_id: "flat_rate",
method_title: "Flat Rate",
total: "10"
}
]
}
woocommerce.post("atum/inventory-logs", data).parsed_response
JSON response example:
{
"id": 2144,
"status": "atum_pending",
"currency": "EUR",
"prices_include_tax": false,
"date_created": "2019-11-11T11:43:49",
"date_modified": "2019-11-11T11:43:50",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "20.00",
"shipping_tax": "2.00",
"cart_tax": "1.20",
"total": "35.20",
"total_tax": "3.20",
"date_completed": "2019-11-11T11:43:51",
"line_items": [
{
"id": 320,
"name": "Woo Single #1",
"product_id": 93,
"variation_id": 0,
"quantity": 2,
"tax_class": "",
"subtotal": "6.00",
"subtotal_tax": "1.20",
"total": "6.00",
"total_tax": "1.20",
"taxes": [
{
"id": 1,
"total": "1.2",
"subtotal": "1.2"
}
],
"meta_data": [],
"sku": "Back Orders",
"price": 3,
"mi_inventories": [
{
"id": 192,
"inventory_id": 152,
"qty": 1,
"subtotal": 3,
"total": 0,
"refund_qty": 0,
"refund_total": 0
},
{
"id": 193,
"inventory_id": 126,
"qty": 1,
"subtotal": 3,
"total": 0,
"refund_qty": 0,
"refund_total": 0
},
{
"id": 194,
"inventory_id": 112,
"qty": 1,
"subtotal": 0,
"total": 0,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": []
},
{
"id": 321,
"name": "Ship Your Idea 2 - Black",
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"tax_class": "",
"subtotal": "0.00",
"subtotal_tax": "0.00",
"total": "0.00",
"total_tax": "0.00",
"taxes": [
{
"id": 1,
"total": "0",
"subtotal": "0"
}
],
"meta_data": {
"9": {
"id": "2750",
"key": "pa_color",
"value": "black"
}
},
"sku": "",
"price": 0,
"mi_inventories": [],
"bom_items": []
}
],
"tax_lines": [
{
"id": 323,
"rate_code": "GB-VAT-1",
"rate_id": 1,
"label": "VAT",
"compound": false,
"tax_total": "1.20",
"shipping_tax_total": "2.00",
"meta_data": []
}
],
"shipping_lines": [
{
"id": 322,
"method_title": "Flat Rate",
"method_id": "flat_rate",
"total": "10.00",
"total_tax": "2.00",
"taxes": [
{
"id": 1,
"total": "2",
"subtotal": ""
}
],
"meta_data": []
}
],
"fee_lines": [],
"description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
"type": "reserved-stock",
"order": false,
"reservation_date": "2019-11-11T11:26:41",
"date_created_gmt": "2019-11-11T10:43:49",
"date_modified_gmt": "2019-11-11T11:43:50",
"date_completed_gmt": "2019-11-11T10:43:51",
"reservation_date_gmt": "2019-11-11T10:26:41",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/2144"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs"
}
]
}
}
Retrieve an inventory log
This API lets you retrieve and view a specific inventory log.
HTTP request
GET
/wp-json/wc/v3/atum/inventory-logs/<id>
curl https://example.com/wp-json/wc/v3/atum/inventory-logs/727 \
-u consumer_key:consumer_secret
WooCommerce.get("atum/inventory-logs/713")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('atum/inventory-logs/713')); ?>
print(wcapi.get("atum/inventory-logs/713").json())
woocommerce.get("atum/inventory-logs/713").parsed_response
JSON response example:
{
"id": 713,
"status": "atum_pending",
"currency": "EUR",
"prices_include_tax": false,
"date_created": "2019-04-09T10:53:00",
"date_modified": "2019-11-11T11:26:27",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "0.00",
"shipping_tax": "0.00",
"cart_tax": "0.00",
"total": "25.32",
"total_tax": "0.00",
"date_completed": "2019-11-11T12:01:13",
"line_items": [
{
"id": 262,
"name": "ABC 123 XPTO",
"product_id": 507,
"variation_id": 0,
"quantity": 2,
"tax_class": "",
"subtotal": "25.32",
"subtotal_tax": "0.00",
"total": "25.32",
"total_tax": "0.00",
"taxes": [],
"meta_data": [],
"sku": "",
"price": 12.66,
"mi_inventories": [
{
"id": 187,
"inventory_id": 152,
"qty": 1,
"subtotal": 20,
"total": 20,
"refund_qty": 0,
"refund_total": 0
},
{
"id": 188,
"inventory_id": 55,
"qty": 1,
"subtotal": 5.32,
"total": 5.32,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": []
}
],
"tax_lines": [],
"shipping_lines": [],
"fee_lines": [],
"description": "The description",
"type": "reserved-stock",
"order": false,
"reservation_date": "2019-11-11T12:01:14",
"date_created_gmt": "2019-04-09T10:53:00",
"date_modified_gmt": "2019-11-11T11:26:27",
"date_completed_gmt": "2019-11-11T11:01:13",
"reservation_date_gmt": "2019-11-11T11:01:14",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/713"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs"
}
]
}
}
Available parameters
| Parameter | Type | Description |
|---|---|---|
dp |
string | Number of decimal points to use in each resource. |
List all inventory logs
This API helps you to view all the inventory logs.
HTTP request
GET
/wp-json/wc/v3/atum/inventory-logs
curl https://example.com/wp-json/wc/v3/atum/inventory-logs \
-u consumer_key:consumer_secret
WooCommerce.get("atum/inventory-logs")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('atum/inventory-logs')); ?>
print(wcapi.get("atum/inventory-logs").json())
woocommerce.get("atum/inventory-logs").parsed_response
JSON response example:
[
{
"id": 713,
"status": "atum_pending",
"currency": "EUR",
"prices_include_tax": false,
"date_created": "2019-04-09T10:53:00",
"date_modified": "2019-11-11T11:26:27",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "0.00",
"shipping_tax": "0.00",
"cart_tax": "0.00",
"total": "25.32",
"total_tax": "0.00",
"date_completed": "2019-11-11T12:15:14",
"line_items": [
{
"id": 262,
"name": "ABC 123 XPTO",
"product_id": 507,
"variation_id": 0,
"quantity": 2,
"tax_class": "",
"subtotal": "25.32",
"subtotal_tax": "0.00",
"total": "25.32",
"total_tax": "0.00",
"taxes": [],
"meta_data": [],
"sku": "",
"price": 12.66,
"mi_inventories": [
{
"id": 187,
"inventory_id": 152,
"qty": 1,
"subtotal": 20,
"total": 20,
"refund_qty": 0,
"refund_total": 0
},
{
"id": 188,
"inventory_id": 55,
"qty": 1,
"subtotal": 5.32,
"total": 5.32,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": []
}
],
"tax_lines": [],
"shipping_lines": [],
"fee_lines": [],
"description": "The description",
"type": "reserved-stock",
"order": false,
"reservation_date": "2019-11-11T12:15:14",
"date_created_gmt": "2019-04-09T10:53:00",
"date_modified_gmt": "2019-11-11T11:26:27",
"date_completed_gmt": "2019-11-11T11:15:14",
"reservation_date_gmt": "2019-11-11T11:15:14",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/713"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs"
}
]
}
},
{
"id": 493,
"status": "atum_pending",
"currency": "EUR",
"prices_include_tax": false,
"date_created": "2018-03-06T08:03:00",
"date_modified": "2019-09-17T11:42:36",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "0.00",
"shipping_tax": "0.00",
"cart_tax": "4.20",
"total": "25.20",
"total_tax": "4.20",
"date_completed": "2019-11-11T12:15:14",
"line_items": [
{
"id": 220,
"name": "Ship Your Idea 2 - Green",
"product_id": 22,
"variation_id": 24,
"quantity": 1,
"tax_class": "",
"subtotal": "20.00",
"subtotal_tax": "4.00",
"total": "20.00",
"total_tax": "4.00",
"taxes": [
{
"id": 1,
"total": "4",
"subtotal": "4"
}
],
"meta_data": {
"9": {
"id": "1727",
"key": "pa_color",
"value": "green"
},
"11": {
"id": "1873",
"key": "_order_id",
"value": "490"
}
},
"sku": "",
"price": 20,
"mi_inventories": [],
"bom_items": []
},
{
"id": 237,
"name": "ABC 123 XPTO",
"product_id": 507,
"variation_id": 0,
"quantity": 1,
"tax_class": "",
"subtotal": "1.00",
"subtotal_tax": "0.20",
"total": "1.00",
"total_tax": "0.20",
"taxes": [
{
"id": 1,
"total": "0.2",
"subtotal": "0.2"
}
],
"meta_data": [],
"sku": "",
"price": 1,
"mi_inventories": [],
"bom_items": []
},
{
"id": 248,
"name": "Woo Ninja",
"product_id": 47,
"variation_id": 0,
"quantity": 1,
"tax_class": "",
"subtotal": "35.00",
"subtotal_tax": "0.00",
"total": "35.00",
"total_tax": "0.00",
"taxes": [],
"meta_data": [],
"sku": "",
"price": 35,
"mi_inventories": [],
"bom_items": []
},
{
"id": 249,
"name": "Woo Logo",
"product_id": 79,
"variation_id": 0,
"quantity": 1,
"tax_class": "",
"subtotal": "15.00",
"subtotal_tax": "0.00",
"total": "15.00",
"total_tax": "0.00",
"taxes": [],
"meta_data": [],
"sku": "",
"price": 15,
"mi_inventories": [],
"bom_items": []
}
],
"tax_lines": [
{
"id": 221,
"rate_code": "GB-VAT-1",
"rate_id": 1,
"label": "VAT",
"compound": false,
"tax_total": "4.20",
"shipping_tax_total": "0.00",
"meta_data": []
}
],
"shipping_lines": [],
"fee_lines": [],
"description": "",
"type": "other",
"order": {},
"custom_name": "Destroyed",
"date_created_gmt": "2018-03-06T08:03:00",
"date_modified_gmt": "2019-09-17T11:42:36",
"date_completed_gmt": "2019-11-11T11:15:14",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/493"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs"
}
]
}
},
{
"id": 492,
"status": "atum_pending",
"currency": "EUR",
"prices_include_tax": false,
"date_created": "2018-03-05T09:55:00",
"date_modified": "2019-04-26T13:43:31",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "0.00",
"shipping_tax": "0.00",
"cart_tax": "4.60",
"total": "39.60",
"total_tax": "4.60",
"date_completed": "2019-11-11T12:15:14",
"line_items": [
{
"id": 219,
"name": "Ship Your Idea 2 - Green",
"product_id": 22,
"variation_id": 24,
"quantity": 1,
"tax_class": "",
"subtotal": "20.00",
"subtotal_tax": "4.00",
"total": "20.00",
"total_tax": "4.00",
"taxes": [
{
"id": 1,
"total": "4",
"subtotal": "4"
}
],
"meta_data": {
"9": {
"id": "1716",
"key": "pa_color",
"value": "green"
},
"10": {
"id": "2188",
"key": "_order_id",
"value": "490"
}
},
"sku": "",
"price": 20,
"mi_inventories": [],
"bom_items": []
},
{
"id": 238,
"name": "ABC 123 XPTO",
"product_id": 507,
"variation_id": 0,
"quantity": 3,
"tax_class": "",
"subtotal": "3.00",
"subtotal_tax": "0.60",
"total": "3.00",
"total_tax": "0.60",
"taxes": [
{
"id": 1,
"total": "0.6",
"subtotal": "0.6"
}
],
"meta_data": [],
"sku": "",
"price": 1,
"mi_inventories": [],
"bom_items": []
},
{
"id": 272,
"name": "Happy Ninja",
"product_id": 37,
"variation_id": 0,
"quantity": 1,
"tax_class": "",
"subtotal": "12.00",
"subtotal_tax": "0.00",
"total": "12.00",
"total_tax": "0.00",
"taxes": [
{
"id": 1,
"total": "",
"subtotal": ""
}
],
"meta_data": [],
"sku": "",
"price": 12,
"mi_inventories": [
{
"id": 131,
"inventory_id": 11,
"qty": 1,
"subtotal": 12,
"total": 12,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": []
}
],
"tax_lines": [
{
"id": 217,
"rate_code": "GB-VAT-1",
"rate_id": 1,
"label": "VAT",
"compound": false,
"tax_total": "4.60",
"shipping_tax_total": "0.00",
"meta_data": []
}
],
"shipping_lines": [],
"fee_lines": [],
"description": "",
"type": "lost-in-post",
"order": false,
"shipping_company": "",
"date_created_gmt": "2018-03-05T09:55:00",
"date_modified_gmt": "2019-04-26T13:43:31",
"date_completed_gmt": "2019-11-11T11:15:14",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/492"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs"
}
]
}
},
{
"id": 317,
"status": "atum_pending",
"currency": "EUR",
"prices_include_tax": false,
"date_created": "2017-07-06T16:29:00",
"date_modified": "2019-04-26T11:23:03",
"discount_total": "-15.00",
"discount_tax": "0.00",
"shipping_total": "2.00",
"shipping_tax": "0.40",
"cart_tax": "7.00",
"total": "71.40",
"total_tax": "7.40",
"date_completed": "2019-11-11T12:15:15",
"line_items": [
{
"id": 87,
"name": "Woo Ninja",
"product_id": 47,
"variation_id": 0,
"quantity": 1,
"tax_class": "",
"subtotal": "35.00",
"subtotal_tax": "7.00",
"total": "35.00",
"total_tax": "7.00",
"taxes": [
{
"id": 1,
"total": "7",
"subtotal": "7"
}
],
"meta_data": [],
"sku": "",
"price": 35,
"mi_inventories": [
{
"id": 76,
"inventory_id": 82,
"qty": 1,
"subtotal": 20,
"total": 20,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": []
},
{
"id": 273,
"name": "Happy Ninja",
"product_id": 37,
"variation_id": 0,
"quantity": 4,
"tax_class": "",
"subtotal": "27.00",
"subtotal_tax": "0.00",
"total": "27.00",
"total_tax": "0.00",
"taxes": [
{
"id": 1,
"total": "",
"subtotal": ""
}
],
"meta_data": [],
"sku": "",
"price": 6.75,
"mi_inventories": [
{
"id": 132,
"inventory_id": 11,
"qty": 1,
"subtotal": 12,
"total": 12,
"refund_qty": 0,
"refund_total": 0
},
{
"id": 133,
"inventory_id": 10,
"qty": 1,
"subtotal": 5,
"total": 5,
"refund_qty": 0,
"refund_total": 0
},
{
"id": 134,
"inventory_id": 13,
"qty": 1,
"subtotal": 5,
"total": 5,
"refund_qty": 0,
"refund_total": 0
},
{
"id": 135,
"inventory_id": 12,
"qty": 1,
"subtotal": 5,
"total": 5,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": []
}
],
"tax_lines": [
{
"id": 89,
"rate_code": "GB-VAT-1",
"rate_id": 1,
"label": "VAT",
"compound": false,
"tax_total": "7.00",
"shipping_tax_total": "0.40",
"meta_data": []
}
],
"shipping_lines": [
{
"id": 88,
"method_title": "Shipping",
"method_id": "flat_rate",
"total": "2.00",
"total_tax": "0.40",
"taxes": [
{
"id": 1,
"total": "0.4",
"subtotal": ""
}
],
"meta_data": []
}
],
"fee_lines": [],
"description": "",
"type": "warehouse-damage",
"order": false,
"damage_date": "2019-11-11T12:15:15",
"date_created_gmt": "2017-07-06T16:29:00",
"date_modified_gmt": "2019-04-26T11:23:03",
"date_completed_gmt": "2019-11-11T11:15:15",
"damage_date_gmt": "2019-11-11T11:15:15",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/317"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs"
}
]
}
},
{
"id": 314,
"status": "atum_pending",
"currency": "EUR",
"prices_include_tax": false,
"date_created": "2017-07-06T15:48:00",
"date_modified": "2017-07-06T16:06:28",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "2.00",
"shipping_tax": "0.40",
"cart_tax": "7.00",
"total": "44.40",
"total_tax": "7.40",
"date_completed": "2019-11-11T12:15:15",
"line_items": [
{
"id": 81,
"name": "Woo Logo",
"product_id": 60,
"variation_id": 0,
"quantity": 1,
"tax_class": "",
"subtotal": "35.00",
"subtotal_tax": "7.00",
"total": "35.00",
"total_tax": "7.00",
"taxes": [
{
"id": 1,
"total": "7",
"subtotal": "7"
}
],
"meta_data": [],
"sku": "",
"price": 35,
"mi_inventories": [],
"bom_items": []
}
],
"tax_lines": [
{
"id": 83,
"rate_code": "GB-VAT-1",
"rate_id": 1,
"label": "VAT",
"compound": false,
"tax_total": "7.00",
"shipping_tax_total": "0.40",
"meta_data": []
}
],
"shipping_lines": [
{
"id": 82,
"method_title": "Shipping",
"method_id": "flat_rate",
"total": "2.00",
"total_tax": "0.40",
"taxes": [
{
"id": 1,
"total": "0.4",
"subtotal": ""
}
],
"meta_data": []
}
],
"fee_lines": [],
"description": "",
"type": "customer-returns",
"order": false,
"return_date": "2019-11-11T12:15:15",
"date_created_gmt": "2017-07-06T15:48:00",
"date_modified_gmt": "2017-07-06T16:06:28",
"date_completed_gmt": "2019-11-11T11:15:15",
"return_date_gmt": "2019-11-11T11:15:15",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/314"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs"
}
]
}
}
]
Available parameters
| Parameter | Type | Description |
|---|---|---|
context |
string | Scope under which the request is made; determines fields present in response. Options: view and edit. Default is view. |
page |
integer | Current page of the collection. Default is 1. |
per_page |
integer | Maximum number of items to be returned in result set. Default is 10. |
search |
string | Limit results to those matching a string. |
after |
string | Limit response to resources published after a given ISO8601 compliant date. |
before |
string | Limit response to resources published before a given ISO8601 compliant date. |
modified_after |
string | Limit response to resources modified after a given ISO8601 compliant date. |
modified_before |
string | Limit response to resources modified before a given ISO8601 compliant date. |
exclude |
array | Ensure result set excludes specific IDs. |
include |
array | Limit result set to specific ids. |
offset |
integer | Offset the result set by a specific number of items. |
order |
string | Order sort attribute ascending or descending. Options: asc and desc. Default is desc. |
orderby |
string | Sort collection by object attribute. Options: date, id, include, title and slug. Default is date. |
parent |
array | Limit result set to those of particular parent IDs. |
parent_exclude |
array | Limit result set to all items except those of a particular parent ID. |
status |
array | Limit result set to inventory logs assigned a specific status. Options: any, atum_pending, atum_completed and trash. Default is any. |
product |
integer | Limit result set to inventory logs assigned a specific product. |
dp |
integer | Number of decimal points to use in each resource. Default is 2. |
type |
array | Limit result set to inventory logs of the specified type(s). Options: reserved-stock, customer-returns, warehouse-damage, lost-in-post, other. |
order_id |
integer | Limit result set to inventory logs linked to the specified WC order ID. |
reservation_date |
string | Limit result set to inventory logs with the reservation date set on a given ISO8601 compliant date. Only available for inventory logs with type reserved-stock. |
return_date |
string | Limit result set to inventory logs with the return date set on a given ISO8601 compliant date. Only available for inventory logs with type customer-returns. |
damage_date |
string | Limit result set to inventory logs with the damage date set on a given ISO8601 compliant date. Only available for inventory logs with type warehouse-damage. |
shipping_company |
string | Limit result set to the inventory logs where the specified company lost the stock in post. Only available for inventory logs with type lost-in-post. |
custom_name |
string | Limit result set to the inventory logs with type 'other' and the specified custom name. |
Update an Invetory log
This API lets you make changes to an inventory log.
HTTP Request
PUT
/wp-json/wc/v3/atum/inventory-logs/<id>
curl -X PUT https://example.com/wp-json/wc/v3/atum/inventory-logs/713 \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"status": "atum_completed"
}'
const data = {
status: "atum_completed"
};
WooCommerce.put("atum/inventory-logs/713", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'status' => 'atum_completed'
];
print_r($woocommerce->put('atum/inventory-logs/713', $data));
?>
data = {
"status": "atum_completed"
}
print(wcapi.put("atum/inventory-logs/713", data).json())
data = {
status: "atum_completed"
}
woocommerce.put("atum/inventory-logs/713", data).parsed_response
JSON response example:
{
"id": 713,
"status": "atum_completed",
"currency": "EUR",
"prices_include_tax": false,
"date_created": "2019-04-09T10:53:00",
"date_modified": "2019-11-11T12:41:09",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "0.00",
"shipping_tax": "0.00",
"cart_tax": "0.00",
"total": "25.32",
"total_tax": "0.00",
"date_completed": "2019-11-11T12:41:09",
"line_items": [
{
"id": 262,
"name": "ABC 123 XPTO",
"product_id": 507,
"variation_id": 0,
"quantity": 2,
"tax_class": "",
"subtotal": "25.32",
"subtotal_tax": "0.00",
"total": "25.32",
"total_tax": "0.00",
"taxes": [],
"meta_data": [],
"sku": "",
"price": 12.66,
"mi_inventories": [
{
"id": 187,
"inventory_id": 152,
"qty": 1,
"subtotal": 20,
"total": 20,
"refund_qty": 0,
"refund_total": 0
},
{
"id": 188,
"inventory_id": 55,
"qty": 1,
"subtotal": 5.32,
"total": 5.32,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": []
}
],
"tax_lines": [],
"shipping_lines": [],
"fee_lines": [],
"description": "The description",
"type": "",
"order": false,
"date_created_gmt": "2019-04-09T10:53:00",
"date_modified_gmt": "2019-11-11T12:41:09",
"date_completed_gmt": "2019-11-11T11:41:09",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/713"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs"
}
]
}
}
Delete an inventory log
This API helps you delete an inventory log.
HTTP request
DELETE
/wp-json/wc/v3/atum/inventory-logs/<id>
curl -X DELETE https://example.com/wp-json/wc/v3/atum/inventory-logs/2144?force=true \
-u consumer_key:consumer_secret
WooCommerce.delete("atum/inventory-logs/2144", {
force: true
})
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->delete('atum/inventory-logs/2144', ['force' => true])); ?>
print(wcapi.delete("atum/inventory-logs/2144", params={"force": True}).json())
woocommerce.delete("atum/inventory-logs/2144", force: true).parsed_response
JSON response example:
{
"id": 2144,
"status": "atum_pending",
"currency": "EUR",
"prices_include_tax": false,
"date_created": "2019-11-11T11:43:49",
"date_modified": "2019-11-11T11:43:50",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "20.00",
"shipping_tax": "2.00",
"cart_tax": "1.20",
"total": "35.20",
"total_tax": "3.20",
"date_completed": "2019-11-11T12:45:13",
"line_items": [
{
"id": 320,
"name": "Woo Single #1",
"product_id": 93,
"variation_id": 0,
"quantity": 2,
"tax_class": "",
"subtotal": "6.00",
"subtotal_tax": "1.20",
"total": "6.00",
"total_tax": "1.20",
"taxes": [
{
"id": 1,
"total": "1.2",
"subtotal": "1.2"
}
],
"meta_data": [],
"sku": "Back Orders",
"price": 3,
"mi_inventories": [
{
"id": 192,
"inventory_id": 152,
"qty": 1,
"subtotal": 3,
"total": 0,
"refund_qty": 0,
"refund_total": 0
},
{
"id": 193,
"inventory_id": 126,
"qty": 1,
"subtotal": 3,
"total": 0,
"refund_qty": 0,
"refund_total": 0
},
{
"id": 194,
"inventory_id": 112,
"qty": 1,
"subtotal": 0,
"total": 0,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": []
},
{
"id": 321,
"name": "Ship Your Idea 2 - Black",
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"tax_class": "",
"subtotal": "0.00",
"subtotal_tax": "0.00",
"total": "0.00",
"total_tax": "0.00",
"taxes": [
{
"id": 1,
"total": "0",
"subtotal": "0"
}
],
"meta_data": {
"9": {
"id": "2750",
"key": "pa_color",
"value": "black"
}
},
"sku": "",
"price": 0,
"mi_inventories": [],
"bom_items": []
}
],
"tax_lines": [
{
"id": 323,
"rate_code": "GB-VAT-1",
"rate_id": 1,
"label": "VAT",
"compound": false,
"tax_total": "1.20",
"shipping_tax_total": "2.00",
"meta_data": []
}
],
"shipping_lines": [
{
"id": 322,
"method_title": "Flat Rate",
"method_id": "flat_rate",
"total": "10.00",
"total_tax": "2.00",
"taxes": [
{
"id": 1,
"total": "2",
"subtotal": ""
}
],
"meta_data": []
}
],
"fee_lines": [],
"description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
"type": "reserved-stock",
"order": false,
"reservation_date": "2019-11-11T11:26:41",
"date_created_gmt": "2019-11-11T10:43:49",
"date_modified_gmt": "2019-11-11T11:43:50",
"date_completed_gmt": "2019-11-11T11:45:13",
"reservation_date_gmt": "2019-11-11T10:26:41",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/2144"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs"
}
]
}
}
Available parameters
| Parameter | Type | Description |
|---|---|---|
force |
string | Use true whether to permanently delete the inventory log, Default is false. |
Batch update inventory logs
This API helps you to batch create, update and delete multiple inventory logs.
HTTP request
POST
/wp-json/wc/v3/atum/inventory-logs/batch
Example of Create, Update and Delete items in bulk:
curl -X POST https://example.com/wp-json/wc/v3/atum/inventory-logs/batch \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"create": [
{
"type": "lost-in-post",
"shipping_company": "UPS",
"line_items": [
{
"product_id": 79,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 13,
"qty": 1
}
]
},
{
"product_id": 93,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 14,
"qty": 1
}
]
},
{
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 58,
"qty": 1
}
]
}
],
"shipping_lines": [
{
"method_id": "flat_rate",
"method_title": "Flat Rate",
"total": 30
}
]
},
{
"type": "other",
"custom_name": "Storm",
"line_items": [
{
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 59,
"qty": 1
}
]
},
{
"product_id": 22,
"variation_id": 24,
"quantity": 1
}
],
"shipping_lines": [
{
"method_id": "flat_rate",
"method_title": "Flat Rate",
"total": 20
}
]
}
],
"update": [
{
"id": 492,
"type": "warehouse-damage",
"damage_date": "2019-11-11T12:15:14"
}
],
"delete": [
2147
]
}'
const data = {
create: [
{
type: "lost-in-post",
shipping_company: "UPS",
line_items: [
{
product_id: 79,
quantity: 1,
mi_inventories: [
{
inventory_id: 13,
qty: 1
}
]
},
{
product_id: 93,
quantity: 1,
mi_inventories: [
{
inventory_id: 14,
qty: 1
}
]
},
{
product_id: 22,
variation_id: 23,
quantity: 1,
mi_inventories: [
{
inventory_id: 58,
qty: 1
}
]
}
],
shipping_lines: [
{
method_id: "flat_rate",
method_title: "Flat Rate",
total: 30
}
]
},
{
type: "other",
custom_name: "Storm",
line_items: [
{
product_id: 22,
variation_id: 23,
quantity: 1,
mi_inventories: [
{
inventory_id: 59,
qty: 1
}
]
},
{
product_id: 22,
variation_id: 24,
quantity: 1
}
],
shipping_lines: [
{
method_id: "flat_rate",
method_title: "Flat Rate",
total: 20
}
]
}
],
update: [
{
id: 492,
type: "warehouse-damage",
damage_date: "2019-11-11T12:15:14"
}
],
delete: [
2147
]
};
WooCommerce.post("atum/inventory-logs/batch", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'create' => [
[
'type' => 'lost-in-post',
'shipping_company' => 'UPS',
'line_items' => [
[
'product_id' => 79,
'quantity' => 1,
'mi_inventories' => [
[
'inventory_id' => 13,
'qty' => 1
]
]
],
[
'product_id' => 93,
'quantity' => 1,
'mi_inventories' => [
[
'inventory_id' => 14,
'qty' => 1
]
]
],
[
'product_id' => 22,
'variation_id' => 23,
'quantity' => 1,
'mi_inventories' => [
[
'inventory_id' => 58,
'qty' => 1
]
]
]
],
'shipping_lines' => [
[
'method_id' => 'flat_rate',
'method_title' => 'Flat Rate',
'total' => 30
]
]
],
[
'type' => 'other',
'custom_name' => 'Storm',
'line_items' => [
[
'product_id' => 22,
'variation_id' => 23,
'quantity' => 1,
'mi_inventories' => [
[
'inventory_id' => 59,
'qty' => 1
]
]
],
[
'product_id' => 22,
'variation_id' => 24,
'quantity' => 1
]
],
'shipping_lines' => [
[
'method_id' => 'flat_rate',
'method_title' => 'Flat Rate',
'total' => 20
]
]
]
],
'update' => [
[
'id' => 492,
'type' => 'warehouse-damage',
'damage_date' => '2019-11-11T12:15:14'
]
],
'delete' => [
2147
]
];
print_r($woocommerce->post('atum/inventory-logs/batch', $data));
?>
data = {
"create": [
{
"type": "lost-in-post",
"shipping_company": "UPS",
"line_items": [
{
"product_id": 79,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 13,
"qty": 1
}
]
},
{
"product_id": 93,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 14,
"qty": 1
}
]
},
{
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 58,
"qty": 1
}
]
}
],
"shipping_lines": [
{
"method_id": "flat_rate",
"method_title": "Flat Rate",
"total": 30
}
]
},
{
"type": "other",
"custom_name": "Storm",
"line_items": [
{
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 59,
"qty": 1
}
]
},
{
"product_id": 22,
"variation_id": 24,
"quantity": 1
}
],
"shipping_lines": [
{
"method_id": "flat_rate",
"method_title": "Flat Rate",
"total": 20
}
]
}
],
"update": [
{
"id": 492,
"type": "warehouse-damage",
"damage_date": "2019-11-11T12:15:14"
}
],
"delete": [
2147
]
}
print(wcapi.post("atum/inventory-logs/batch", data).json())
data = {
create: [
{
type: "lost-in-post",
shipping_company: "UPS",
line_items: [
{
product_id: 79,
quantity: 1,
mi_inventories: [
{
inventory_id: 13,
qty: 1
}
]
},
{
product_id: 93,
quantity: 1,
mi_inventories: [
{
inventory_id: 14,
qty: 1
}
]
},
{
product_id: 22,
variation_id: 23,
quantity: 1,
mi_inventories: [
{
inventory_id: 58,
qty: 1
}
]
}
],
shipping_lines: [
{
method_id: "flat_rate",
method_title: "Flat Rate",
total: 30
}
]
},
{
type: "other",
custom_name: "Storm",
line_items: [
{
product_id: 22,
variation_id: 23,
quantity: 1,
mi_inventories: [
{
inventory_id: 59,
qty: 1
}
]
},
{
product_id: 22,
variation_id: 24,
quantity: 1
}
],
shipping_lines: [
{
method_id: "flat_rate",
method_title: "Flat Rate",
total: 20
}
]
}
],
update: [
{
id: 492,
type: "warehouse-damage",
damage_date: "2019-11-11T12:15:14"
}
],
delete: [
2147
]
}
woocommerce.post("atum/inventory-logs/batch", data).parsed_response
JSON response example:
{
"create": [
{
"id": 2149,
"status": "atum_pending",
"currency": "EUR",
"prices_include_tax": false,
"date_created": "2019-11-11T12:54:23",
"date_modified": "2019-11-11T12:54:25",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "60.00",
"shipping_tax": "6.00",
"cart_tax": "3.60",
"total": "105.60",
"total_tax": "9.60",
"date_completed": "2019-11-11T12:54:25",
"line_items": [
{
"id": 328,
"name": "Woo Logo",
"product_id": 79,
"variation_id": 0,
"quantity": 1,
"tax_class": "",
"subtotal": "15.00",
"subtotal_tax": "3.00",
"total": "15.00",
"total_tax": "3.00",
"taxes": [
{
"id": 1,
"total": "3",
"subtotal": "3"
}
],
"meta_data": [],
"sku": "",
"price": 15,
"mi_inventories": [
{
"id": 198,
"inventory_id": 13,
"qty": 1,
"subtotal": 15,
"total": 0,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": []
},
{
"id": 329,
"name": "Woo Single #1",
"product_id": 93,
"variation_id": 0,
"quantity": 1,
"tax_class": "",
"subtotal": "3.00",
"subtotal_tax": "0.60",
"total": "3.00",
"total_tax": "0.60",
"taxes": [
{
"id": 1,
"total": "0.6",
"subtotal": "0.6"
}
],
"meta_data": [],
"sku": "Back Orders",
"price": 3,
"mi_inventories": [
{
"id": 199,
"inventory_id": 14,
"qty": 1,
"subtotal": 3,
"total": 0,
"refund_qty": 0,
"refund_total": 0
},
{
"id": 200,
"inventory_id": 58,
"qty": 1,
"subtotal": 9,
"total": 0,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": []
},
{
"id": 330,
"name": "Ship Your Idea 2 - Black",
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"tax_class": "",
"subtotal": "0.00",
"subtotal_tax": "0.00",
"total": "0.00",
"total_tax": "0.00",
"taxes": [
{
"id": 1,
"total": "0",
"subtotal": "0"
}
],
"meta_data": {
"9": {
"id": "2815",
"key": "pa_color",
"value": "black"
}
},
"sku": "",
"price": 0,
"mi_inventories": [],
"bom_items": []
}
],
"tax_lines": [
{
"id": 332,
"rate_code": "GB-VAT-1",
"rate_id": 1,
"label": "VAT",
"compound": false,
"tax_total": "3.60",
"shipping_tax_total": "6.00",
"meta_data": []
}
],
"shipping_lines": [
{
"id": 331,
"method_title": "Flat Rate",
"method_id": "flat_rate",
"total": "30.00",
"total_tax": "6.00",
"taxes": [
{
"id": 1,
"total": "6",
"subtotal": ""
}
],
"meta_data": []
}
],
"fee_lines": [],
"description": "",
"type": "lost-in-post",
"order": false,
"shipping_company": "UPS",
"date_created_gmt": "2019-11-11T11:54:23",
"date_modified_gmt": "2019-11-11T12:54:25",
"date_completed_gmt": "2019-11-11T11:54:25",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/2149"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs"
}
]
}
},
{
"id": 2150,
"status": "atum_pending",
"currency": "EUR",
"prices_include_tax": false,
"date_created": "2019-11-11T12:54:26",
"date_modified": "2019-11-11T12:54:27",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "40.00",
"shipping_tax": "4.00",
"cart_tax": "4.00",
"total": "88.00",
"total_tax": "8.00",
"date_completed": "2019-11-11T12:54:28",
"line_items": [
{
"id": 333,
"name": "Ship Your Idea 2 - Black",
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"tax_class": "",
"subtotal": "0.00",
"subtotal_tax": "0.00",
"total": "0.00",
"total_tax": "0.00",
"taxes": [
{
"id": 1,
"total": "0",
"subtotal": "0"
}
],
"meta_data": {
"9": {
"id": "2834",
"key": "pa_color",
"value": "black"
}
},
"sku": "",
"price": 0,
"mi_inventories": [],
"bom_items": []
},
{
"id": 334,
"name": "Ship Your Idea 2 - Green",
"product_id": 22,
"variation_id": 24,
"quantity": 1,
"tax_class": "",
"subtotal": "20.00",
"subtotal_tax": "4.00",
"total": "20.00",
"total_tax": "4.00",
"taxes": [
{
"id": 1,
"total": "4",
"subtotal": "4"
}
],
"meta_data": {
"9": {
"id": "2844",
"key": "pa_color",
"value": "green"
}
},
"sku": "",
"price": 20,
"mi_inventories": [],
"bom_items": []
}
],
"tax_lines": [
{
"id": 336,
"rate_code": "GB-VAT-1",
"rate_id": 1,
"label": "VAT",
"compound": false,
"tax_total": "4.00",
"shipping_tax_total": "4.00",
"meta_data": []
}
],
"shipping_lines": [
{
"id": 335,
"method_title": "Flat Rate",
"method_id": "flat_rate",
"total": "20.00",
"total_tax": "4.00",
"taxes": [
{
"id": 1,
"total": "4",
"subtotal": ""
}
],
"meta_data": []
}
],
"fee_lines": [],
"description": "",
"type": "other",
"order": false,
"custom_name": "Storm",
"date_created_gmt": "2019-11-11T11:54:26",
"date_modified_gmt": "2019-11-11T12:54:27",
"date_completed_gmt": "2019-11-11T11:54:28",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/2150"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs"
}
]
}
}
],
"update": [
{
"id": 492,
"status": "atum_pending",
"currency": "EUR",
"prices_include_tax": false,
"date_created": "2018-03-05T09:55:00",
"date_modified": "2019-11-11T12:54:28",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "0.00",
"shipping_tax": "0.00",
"cart_tax": "4.60",
"total": "39.60",
"total_tax": "4.60",
"date_completed": "2019-11-11T12:54:29",
"line_items": [
{
"id": 219,
"name": "Ship Your Idea 2 - Green",
"product_id": 22,
"variation_id": 24,
"quantity": 1,
"tax_class": "",
"subtotal": "20.00",
"subtotal_tax": "4.00",
"total": "20.00",
"total_tax": "4.00",
"taxes": [
{
"id": 1,
"total": "4",
"subtotal": "4"
}
],
"meta_data": {
"9": {
"id": "1716",
"key": "pa_color",
"value": "green"
},
"10": {
"id": "2188",
"key": "_order_id",
"value": "490"
}
},
"sku": "",
"price": 20,
"mi_inventories": [],
"bom_items": []
},
{
"id": 238,
"name": "ABC 123 XPTO",
"product_id": 507,
"variation_id": 0,
"quantity": 3,
"tax_class": "",
"subtotal": "3.00",
"subtotal_tax": "0.60",
"total": "3.00",
"total_tax": "0.60",
"taxes": [
{
"id": 1,
"total": "0.6",
"subtotal": "0.6"
}
],
"meta_data": [],
"sku": "",
"price": 1,
"mi_inventories": [],
"bom_items": []
},
{
"id": 272,
"name": "Happy Ninja",
"product_id": 37,
"variation_id": 0,
"quantity": 1,
"tax_class": "",
"subtotal": "12.00",
"subtotal_tax": "0.00",
"total": "12.00",
"total_tax": "0.00",
"taxes": [
{
"id": 1,
"total": "",
"subtotal": ""
}
],
"meta_data": [],
"sku": "",
"price": 12,
"mi_inventories": [
{
"id": 131,
"inventory_id": 11,
"qty": 1,
"subtotal": 12,
"total": 12,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": []
}
],
"tax_lines": [
{
"id": 217,
"rate_code": "GB-VAT-1",
"rate_id": 1,
"label": "VAT",
"compound": false,
"tax_total": "4.60",
"shipping_tax_total": "0.00",
"meta_data": []
}
],
"shipping_lines": [],
"fee_lines": [],
"description": "",
"type": "warehouse-damage",
"order": false,
"damage_date": "2019-11-11T12:15:14",
"date_created_gmt": "2018-03-05T09:55:00",
"date_modified_gmt": "2019-11-11T12:54:28",
"date_completed_gmt": "2019-11-11T11:54:29",
"damage_date_gmt": "2019-11-11T11:15:14",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/492"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs"
}
]
}
}
],
"delete": [
{
"id": 2147,
"status": "atum_pending",
"currency": "EUR",
"prices_include_tax": false,
"date_created": "2019-11-11T12:50:49",
"date_modified": "2019-11-11T12:50:50",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "20.00",
"shipping_tax": "2.00",
"cart_tax": "1.20",
"total": "35.20",
"total_tax": "3.20",
"date_completed": "2019-11-11T12:54:29",
"line_items": [
{
"id": 324,
"name": "Woo Single #1",
"product_id": 93,
"variation_id": 0,
"quantity": 2,
"tax_class": "",
"subtotal": "6.00",
"subtotal_tax": "1.20",
"total": "6.00",
"total_tax": "1.20",
"taxes": [
{
"id": 1,
"total": "1.2",
"subtotal": "1.2"
}
],
"meta_data": [],
"sku": "Back Orders",
"price": 3,
"mi_inventories": [
{
"id": 195,
"inventory_id": 152,
"qty": 1,
"subtotal": 3,
"total": 0,
"refund_qty": 0,
"refund_total": 0
},
{
"id": 196,
"inventory_id": 126,
"qty": 1,
"subtotal": 3,
"total": 0,
"refund_qty": 0,
"refund_total": 0
},
{
"id": 197,
"inventory_id": 112,
"qty": 1,
"subtotal": 0,
"total": 0,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": []
},
{
"id": 325,
"name": "Ship Your Idea 2 - Black",
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"tax_class": "",
"subtotal": "0.00",
"subtotal_tax": "0.00",
"total": "0.00",
"total_tax": "0.00",
"taxes": [
{
"id": 1,
"total": "0",
"subtotal": "0"
}
],
"meta_data": {
"9": {
"id": "2778",
"key": "pa_color",
"value": "black"
}
},
"sku": "",
"price": 0,
"mi_inventories": [],
"bom_items": []
}
],
"tax_lines": [
{
"id": 327,
"rate_code": "GB-VAT-1",
"rate_id": 1,
"label": "VAT",
"compound": false,
"tax_total": "1.20",
"shipping_tax_total": "2.00",
"meta_data": []
}
],
"shipping_lines": [
{
"id": 326,
"method_title": "Flat Rate",
"method_id": "flat_rate",
"total": "10.00",
"total_tax": "2.00",
"taxes": [
{
"id": 1,
"total": "2",
"subtotal": ""
}
],
"meta_data": []
}
],
"fee_lines": [],
"description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
"type": "reserved-stock",
"order": false,
"reservation_date": "2019-11-11T11:26:41",
"date_created_gmt": "2019-11-11T11:50:49",
"date_modified_gmt": "2019-11-11T12:50:50",
"date_completed_gmt": "2019-11-11T11:54:29",
"reservation_date_gmt": "2019-11-11T10:26:41",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/2147"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs"
}
]
}
}
]
}
Inventory log notes
ATUM
The inventory log notes API allows you to create, view, and delete individual inventory log notes.
Inventory log notes are added by administrators and programmatically to store data about an inventory log, or its events.
Inventory log note properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Unique identifier for the resource. read-only |
author |
string | Inventory log note author. read-only |
date_created |
date-time | The date the inventory log note was created, in the site's timezone. read-only |
date_created_gmt |
date-time | The date the inventory log note was created, as GMT. read-only |
note |
string | Inventory log note content. mandatory |
added_by_user |
boolean | If true, this note will be attributed to the current user. If false, the note will be attributed to the system. Default is false. |
Create an inventory log note
This API helps you to create a new note for an inventory log.
HTTP request
POST
/wp-json/wc/v3/atum/inventory-logs/<id>/notes
curl -X POST https://example.com/wp-json/wc/v3/atum/inventory-logs/713/notes \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"note": "Test Note!!!"
}'
const data = {
note: "Test Note!!!"
};
WooCommerce.post("atum/inventory-logs/713/notes", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'note' => 'Test Note!!!'
];
print_r($woocommerce->post('atum/inventory-logs/713/notes', $data));
?>
data = {
"note": "Test Note!!!"
}
print(wcapi.post("atum/inventory-logs/713/notes", data).json())
data = {
note: "Test Note!!!"
}
woocommerce.post("atum/inventory-logs/713/notes", data).parsed_response
JSON response example:
{
"id": 4202,
"author": "John Doe",
"date_created": "2019-11-11T13:27:10",
"date_created_gmt": "2019-11-11T12:27:10",
"note": "Test Note!!!",
"added_by_user": false,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/713/notes/4202"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/713/notes"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/713"
}
]
}
}
Retrieve an inventory log note
This API lets you retrieve and view a specific note from an inventory log.
HTTP request
GET
/wp-json/wc/v3/atum/inventory-logs/<id>/notes/<note_id>
curl https://example.com/wp-json/wc/v3/atum/inventory-logs/713/notes/4202 \
-u consumer_key:consumer_secret
WooCommerce.get("atum/inventory-logs/713/notes/4202")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('atum/inventory-logs/713/notes/4202')); ?>
print(wcapi.get("atum/inventory-logs/713/notes/4202").json())
woocommerce.get("atum/inventory-logs/713/notes/4202").parsed_response
JSON response example:
{
"id": 4202,
"author": "John Doe",
"date_created": "2019-11-11T13:27:10",
"date_created_gmt": "2019-11-11T12:27:10",
"note": "Test Note!!!",
"added_by_user": false,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/713/notes/4202"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/713/notes"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/713"
}
]
}
}
List all inventory log notes
This API helps you to view all the notes from an inventory log.
HTTP request
GET
/wp-json/wc/v3/atum/inventory-logs/<id>/notes
curl https://example.com/wp-json/wc/v3/atum/inventory-logs/493/notes \
-u consumer_key:consumer_secret
WooCommerce.get("atum/inventory-logs/493/notes")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('atum/inventory-logs/493/notes')); ?>
print(wcapi.get("atum/inventory-logs/493/notes").json())
woocommerce.get("atum/inventory-logs/493/notes").parsed_response
JSON response example:
[
{
"id": 616,
"author": "John Doe",
"date_created": "2019-03-12T09:47:46",
"date_created_gmt": "2019-03-12T09:47:46",
"note": "testing",
"added_by_user": true,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/493/notes/616"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/493/notes"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/493"
}
]
}
},
{
"id": 589,
"author": "ATUM",
"date_created": "2019-03-05T11:17:16",
"date_created_gmt": "2019-03-05T11:17:16",
"note": "Order status changed from Completed to Pending.",
"added_by_user": false,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/493/notes/589"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/493/notes"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/493"
}
]
}
},
{
"id": 588,
"author": "ATUM",
"date_created": "2019-03-05T11:16:26",
"date_created_gmt": "2019-03-05T11:16:26",
"note": "Order status changed from Pending to Completed.",
"added_by_user": false,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/493/notes/588"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/493/notes"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/493"
}
]
}
},
{
"id": 274,
"author": "ATUM",
"date_created": "2018-04-04T07:26:35",
"date_created_gmt": "2018-04-04T06:26:35",
"note": "Item 24 stock increased from 4 to 5.",
"added_by_user": false,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/493/notes/274"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/493/notes"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/493"
}
]
}
},
{
"id": 266,
"author": "ATUM",
"date_created": "2018-03-14T11:32:20",
"date_created_gmt": "2018-03-14T11:32:20",
"note": "Item 24 stock increased from 3 to 4.",
"added_by_user": false,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/493/notes/266"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/493/notes"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/493"
}
]
}
},
{
"id": 255,
"author": "ATUM",
"date_created": "2018-03-06T08:04:30",
"date_created_gmt": "2018-03-06T08:04:30",
"note": "Item 24 stock decreased from 2 to 1.",
"added_by_user": false,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/493/notes/255"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/493/notes"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/493"
}
]
}
},
{
"id": 254,
"author": "ATUM",
"date_created": "2018-03-06T08:04:12",
"date_created_gmt": "2018-03-06T08:04:12",
"note": "Item 24 stock increased from 1 to 2.",
"added_by_user": false,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/493/notes/254"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/493/notes"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/493"
}
]
}
}
]
Available parameters
| Parameter | Type | Description |
|---|---|---|
type |
string | Limit result to user or system notes. Options: any, user and system. Default is any. |
Delete an inventory log note
This API helps you delete an inventory log note.
HTTP request
DELETE
/wp-json/wc/v3/atum/inventory-logs/<id>/notes/<note_id>
curl -X DELETE https://example.com/wp-json/wc/v3/atum/inventory-logs/713/notes/4202?force=true \
-u consumer_key:consumer_secret
WooCommerce.delete("atum/inventory-logs/713/notes/4202", {
force: true
})
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->delete('atum/inventory-logs/713/notes/4202', ['force' => true])); ?>
print(wcapi.delete("atum/inventory-logs/713/notes/4202", params={"force": True}).json())
woocommerce.delete("atum/inventory-logs/713/notes/4202", force: true).parsed_response
JSON response example:
{
"id": 4202,
"author": "ATUM",
"date_created": "2019-11-11T13:27:10",
"date_created_gmt": "2019-11-11T12:27:10",
"note": "Test Note!!!",
"added_by_user": false,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/713/notes/4202"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/713/notes"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/atum/inventory-logs/713"
}
]
}
}
Available parameters
| Parameter | Type | Description |
|---|---|---|
force |
string | Required to be true, as resource does not support trashing. |
Orders
This endpoint is an extension of the official WC's orders enndpoint with extra info added by ATUM and/or its add-ons. You can identify the ATUM data with the corresponding labels.
The orders API allows you to create, view, update, and delete individual, or a batch, of orders.
Order properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Unique identifier for the resource. read-only |
parent_id |
integer | Parent order ID. |
number |
string | Order number. read-only |
order_key |
string | Order key. read-only |
created_via |
string | Shows where the order was created. read-only |
version |
string | Version of WooCommerce which last updated the order. read-only |
status |
string | Order status. Options: pending, processing, on-hold, completed, cancelled, refunded, failed and trash. Default is pending. |
currency |
string | Currency the order was created with, in ISO format. Options: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTC, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, IRT, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PRB, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR and ZMW. Default is USD. |
date_created |
date-time | The date the order was created, in the site's timezone. read-only |
date_created_gmt |
date-time | The date the order was created, as GMT. read-only |
date_modified |
date-time | The date the order was last modified, in the site's timezone. read-only |
date_modified_gmt |
date-time | The date the order was last modified, as GMT. read-only |
discount_total |
string | Total discount amount for the order. read-only |
discount_tax |
string | Total discount tax amount for the order. read-only |
shipping_total |
string | Total shipping amount for the order. read-only |
shipping_tax |
string | Total shipping tax amount for the order. read-only |
cart_tax |
string | Sum of line item taxes only. read-only |
total |
string | Grand total. read-only |
total_tax |
string | Sum of all taxes. read-only |
prices_include_tax |
boolean | True the prices included tax during checkout. read-only |
customer_id |
integer | User ID who owns the order. 0 for guests. Default is 0. |
customer_ip_address |
string | Customer's IP address. read-only |
customer_user_agent |
string | User agent of the customer. read-only |
customer_note |
string | Note left by customer during checkout. |
billing |
object | Billing address. See Order - Billing properties |
shipping |
object | Shipping address. See Order - Shipping properties |
payment_method |
string | Payment method ID. |
payment_method_title |
string | Payment method title. |
transaction_id |
string | Unique transaction ID. |
date_paid |
date-time | The date the order was paid, in the site's timezone. read-only |
date_paid_gmt |
date-time | The date the order was paid, as GMT. read-only |
date_completed |
date-time | The date the order was completed, in the site's timezone. read-only |
date_completed_gmt |
date-time | The date the order was completed, as GMT. read-only |
cart_hash |
string | MD5 hash of cart items to ensure orders are not modified. read-only |
meta_data |
array | Meta data. See Order - Meta data properties |
line_items |
array | Line items data. See Order - Line items properties |
tax_lines |
array | Tax lines data. See Order - Tax lines properties read-only |
shipping_lines |
array | Shipping lines data. See Order - Shipping lines properties |
fee_lines |
array | Fee lines data. See Order - Fee lines properties |
coupon_lines |
array | Coupons line data. See Order - Coupon lines properties |
refunds |
array | List of refunds. See Order - Refunds properties read-only |
set_paid |
boolean | Define if the order is paid. It will set the status to processing and reduce stock items. Default is false. write-only |
Order - Billing properties
| Attribute | Type | Description |
|---|---|---|
first_name |
string | First name. |
last_name |
string | Last name. |
company |
string | Company name. |
address_1 |
string | Address line 1 |
address_2 |
string | Address line 2 |
city |
string | City name. |
state |
string | ISO code or name of the state, province or district. |
postcode |
string | Postal code. |
country |
string | Country code in ISO 3166-1 alpha-2 format. |
email |
string | Email address. |
phone |
string | Phone number. |
Order - Shipping properties
| Attribute | Type | Description |
|---|---|---|
first_name |
string | First name. |
last_name |
string | Last name. |
company |
string | Company name. |
address_1 |
string | Address line 1 |
address_2 |
string | Address line 2 |
city |
string | City name. |
state |
string | ISO code or name of the state, province or district. |
postcode |
string | Postal code. |
country |
string | Country code in ISO 3166-1 alpha-2 format. |
Order - Meta data properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Meta ID. read-only |
key |
string | Meta key. |
value |
string | Meta value. |
Order - Line items properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Item ID. read-only |
name |
string | Product name. |
product_id |
integer | Product ID. |
variation_id |
integer | Variation ID, if applicable. |
quantity |
integer | Quantity ordered. |
tax_class |
string | Slug of the tax class of product. |
subtotal |
string | Line subtotal (before discounts). |
subtotal_tax |
string | Line subtotal tax (before discounts). read-only |
total |
string | Line total (after discounts). |
total_tax |
string | Line total tax (after discounts). read-only |
taxes |
array | Line taxes. See Order - Taxes properties read-only |
meta_data |
array | Meta data. See Order - Meta data properties |
sku |
string | Product SKU. read-only |
price |
string | Product price. read-only |
mi_inventories |
array | Multi-Inventory order items. See Order - MI Order Items properties Multi-Inventory ATUM |
bom_items |
array | BOM order items. See Order - BOM Order Items properties read-only Product Levels ATUM |
Order - Tax lines properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Item ID. read-only |
rate_code |
string | Tax rate code. read-only |
rate_id |
string | Tax rate ID. read-only |
label |
string | Tax rate label. read-only |
compound |
boolean | Show if is a compound tax rate. read-only |
tax_total |
string | Tax total (not including shipping taxes). read-only |
shipping_tax_total |
string | Shipping tax total. read-only |
meta_data |
array | Meta data. See Order - Meta data properties |
Order - Shipping lines properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Item ID. read-only |
method_title |
string | Shipping method name. |
method_id |
string | Shipping method ID. |
total |
string | Line total (after discounts). |
total_tax |
string | Line total tax (after discounts). read-only |
taxes |
array | Line taxes. See Order - Taxes properties read-only |
meta_data |
array | Meta data. See Order - Meta data properties |
Order - Fee lines properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Item ID. read-only |
name |
string | Fee name. |
tax_class |
string | Tax class of fee. |
tax_status |
string | Tax status of fee. Options: taxable and none. |
total |
string | Line total (after discounts). |
total_tax |
string | Line total tax (after discounts). read-only |
taxes |
array | Line taxes. See Order - Taxes properties read-only |
meta_data |
array | Meta data. See Order - Meta data properties |
Order - Coupon lines properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Item ID. read-only |
code |
string | Coupon code. |
discount |
string | Discount total. read-only |
discount_tax |
string | Discount total tax. read-only |
meta_data |
array | Meta data. See Order - Meta data properties |
Order - Refunds properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Refund ID. read-only |
reason |
string | Refund reason. read-only |
total |
string | Refund total. read-only |
Order - Taxes properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Item ID. read-only |
rate_code |
string | Tax rate code. read-only |
rate_id |
string | Tax rate ID. read-only |
label |
string | Tax rate label. read-only |
compound |
boolean | Show if is a compound tax rate. read-only |
tax_total |
string | Tax total (not including shipping taxes). read-only |
shipping_tax_total |
string | Shipping tax total. read-only |
meta_data |
array | Meta data. See Order - Meta data properties |
Order - MI Order Items properties ATUM Multi-Inventory
| Attribute | Type | Description |
|---|---|---|
id |
integer | The order item inventory ID. |
delete |
boolean | Set to true to delete the order item inventory with the specified inventory ID. write-only |
order_item_id |
integer | The order item ID linked to this order item inventory. |
inventory_id |
integer | The inventory ID linked to the order item. |
product_id |
integer | The product ID from where the inventory comes. |
qty |
number | The quantity of the specified inventory that is used on the order item. |
order_type |
integer | The type of order (WC Order = 1, Purchase Order = 2, Inventory Log = 3). |
subtotal |
number | Order item inventory's subtotal. |
total |
number | Order item inventory's total. |
refund_qty |
number | Order item inventory's refund quantity. |
refund_total |
number | Order item inventory's refund total. |
Order - BOM Order Items properties ATUM Product Levels
| Attribute | Type | Description |
|---|---|---|
id |
integer | The BOM order item ID. read-only |
bom_id |
integer | The BOM product ID associated to the BOM order item. read-only |
bom_type |
string | The BOM product type. Options: product_part and raw_material. read-only |
qty |
number | The quantity of the specified BOM that is used on the order item. read-only |
Create an order
This API helps you to create a new order.
HTTP request
POST
/wp-json/wc/v3/orders
Example of create a paid order with Multi-Inventory's order items and BOM order items:
curl -X POST https://example.com/wp-json/wc/v3/orders \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"payment_method": "bacs",
"payment_method_title": "Direct Bank Transfer",
"set_paid": true,
"billing": {
"first_name": "John",
"last_name": "Doe",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US",
"email": "john.doe@example.com",
"phone": "(555) 555-5555"
},
"shipping": {
"first_name": "John",
"last_name": "Doe",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US"
},
"line_items": [
{
"product_id": 93,
"quantity": 2,
"mi_inventories": [
{
"inventory_id": 152,
"qty": 1
},
{
"inventory_id": 126,
"qty": 1
}
]
},
{
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 112,
"qty": 1
}
]
}
],
"shipping_lines": [
{
"method_id": "flat_rate",
"method_title": "Flat Rate",
"total": 10
}
]
}'
const data = {
payment_method: "bacs",
payment_method_title: "Direct Bank Transfer",
set_paid: true,
billing: {
first_name: "John",
last_name: "Doe",
address_1: "969 Market",
address_2: "",
city: "San Francisco",
state: "CA",
postcode: "94103",
country: "US",
email: "john.doe@example.com",
phone: "(555) 555-5555"
},
shipping: {
first_name: "John",
last_name: "Doe",
address_1: "969 Market",
address_2: "",
city: "San Francisco",
state: "CA",
postcode: "94103",
country: "US"
},
line_items: [
{
product_id: 93,
quantity: 2,
mi_inventories: [
{
inventory_id: 152,
qty: 1
},
{
inventory_id: 126,
qty: 1
}
]
},
{
product_id: 22,
variation_id: 23,
quantity: 1,
mi_inventories: [
{
inventory_id: 112,
qty: 1
}
]
}
],
shipping_lines: [
{
method_id: "flat_rate",
method_title: "Flat Rate",
total: 10
}
]
};
WooCommerce.post("orders", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'payment_method' => 'bacs',
'payment_method_title' => 'Direct Bank Transfer',
'set_paid' => true,
'billing' => [
'first_name' => 'John',
'last_name' => 'Doe',
'address_1' => '969 Market',
'address_2' => '',
'city' => 'San Francisco',
'state' => 'CA',
'postcode' => '94103',
'country' => 'US',
'email' => 'john.doe@example.com',
'phone' => '(555) 555-5555'
],
'shipping' => [
'first_name' => 'John',
'last_name' => 'Doe',
'address_1' => '969 Market',
'address_2' => '',
'city' => 'San Francisco',
'state' => 'CA',
'postcode' => '94103',
'country' => 'US'
],
'line_items' => [
[
'product_id' => 93,
'quantity' => 2,
'mi_inventories' => [
[
'inventory_id' => 152,
'qty' => 1
],
[
'inventory_id' => 126,
'qty' => 1
]
]
],
[
'product_id' => 22,
'variation_id' => 23,
'quantity' => 1,
'mi_inventories' => [
[
'inventory_id' => 112,
'qty' => 1
]
]
]
],
'shipping_lines' => [
[
'method_id' => 'flat_rate',
'method_title' => 'Flat Rate',
'total' => 10
]
]
];
print_r($woocommerce->post('orders', $data));
?>
data = {
"payment_method": "bacs",
"payment_method_title": "Direct Bank Transfer",
"set_paid": True,
"billing": {
"first_name": "John",
"last_name": "Doe",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US",
"email": "john.doe@example.com",
"phone": "(555) 555-5555"
},
"shipping": {
"first_name": "John",
"last_name": "Doe",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US"
},
"line_items": [
{
"product_id": 93,
"quantity": 2,
"mi_inventories": [
{
"inventory_id": 152,
"qty": 1
},
{
"inventory_id": 126,
"qty": 1
}
]
},
{
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 112,
"qty": 1
}
]
}
],
"shipping_lines": [
{
"method_id": "flat_rate",
"method_title": "Flat Rate",
"total": 10
}
]
}
print(wcapi.post("orders", data).json())
data = {
payment_method: "bacs",
payment_method_title: "Direct Bank Transfer",
set_paid: true,
billing: {
first_name: "John",
last_name: "Doe",
address_1: "969 Market",
address_2: "",
city: "San Francisco",
state: "CA",
postcode: "94103",
country: "US",
email: "john.doe@example.com",
phone: "(555) 555-5555"
},
shipping: {
first_name: "John",
last_name: "Doe",
address_1: "969 Market",
address_2: "",
city: "San Francisco",
state: "CA",
postcode: "94103",
country: "US"
},
line_items: [
{
product_id: 93,
quantity: 2,
mi_inventories: [
{
inventory_id: 152,
qty: 1
},
{
inventory_id: 126,
qty: 1
}
]
},
{
product_id: 22,
variation_id: 23,
quantity: 1,
mi_inventories: [
{
inventory_id: 112,
qty: 1
}
]
}
],
shipping_lines: [
{
method_id: "flat_rate",
method_title: "Flat Rate",
total: 10
}
]
}
woocommerce.post("orders", data).parsed_response
JSON response example:
{
"id": 727,
"parent_id": 0,
"number": "727",
"order_key": "wc_order_58d2d042d1d",
"created_via": "rest-api",
"version": "3.0.0",
"status": "processing",
"currency": "USD",
"date_created": "2019-03-22T16:28:02",
"date_created_gmt": "2019-03-22T19:28:02",
"date_modified": "2019-03-22T16:28:08",
"date_modified_gmt": "2019-03-22T19:28:08",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "10.00",
"shipping_tax": "0.00",
"cart_tax": "1.35",
"total": "29.35",
"total_tax": "1.35",
"prices_include_tax": false,
"customer_id": 0,
"customer_ip_address": "",
"customer_user_agent": "",
"customer_note": "",
"billing": {
"first_name": "John",
"last_name": "Doe",
"company": "",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US",
"email": "john.doe@example.com",
"phone": "(555) 555-5555"
},
"shipping": {
"first_name": "John",
"last_name": "Doe",
"company": "",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US"
},
"payment_method": "bacs",
"payment_method_title": "Direct Bank Transfer",
"transaction_id": "",
"date_paid": "2019-03-22T16:28:08",
"date_paid_gmt": "2019-03-22T19:28:08",
"date_completed": null,
"date_completed_gmt": null,
"cart_hash": "",
"meta_data": [
{
"id": 13106,
"key": "_download_permissions_granted",
"value": "yes"
}
],
"line_items": [
{
"id": 315,
"name": "Woo Single #1",
"product_id": 93,
"variation_id": 0,
"quantity": 2,
"tax_class": "",
"subtotal": "6.00",
"subtotal_tax": "0.45",
"total": "6.00",
"total_tax": "0.45",
"taxes": [
{
"id": 75,
"total": "0.45",
"subtotal": "0.45"
}
],
"meta_data": [],
"sku": "",
"price": 3,
"mi_inventories": [
{
"id": 191,
"inventory_id": 152,
"qty": 1,
"subtotal": 6,
"total": 6,
"refund_qty": 0,
"refund_total": 0
},
{
"id": 192,
"inventory_id": 126,
"qty": 1,
"subtotal": 6,
"total": 6,
"refund_qty": 0,
"refund_total": 0
}
]
},
{
"id": 316,
"name": "Ship Your Idea – Color: Black, Size: M Test",
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"tax_class": "",
"subtotal": "12.00",
"subtotal_tax": "0.90",
"total": "12.00",
"total_tax": "0.90",
"taxes": [
{
"id": 75,
"total": "0.9",
"subtotal": "0.9"
}
],
"meta_data": [
{
"id": 2095,
"key": "pa_color",
"value": "black"
},
{
"id": 2096,
"key": "size",
"value": "M Test"
}
],
"sku": "Bar3",
"price": 12,
"mi_inventories": [
{
"id": 193,
"inventory_id": 112,
"qty": 1,
"subtotal": 12,
"total": 12,
"refund_qty": 0,
"refund_total": 0
}
]
}
],
"tax_lines": [
{
"id": 318,
"rate_code": "US-CA-STATE TAX",
"rate_id": 75,
"label": "State Tax",
"compound": false,
"tax_total": "1.35",
"shipping_tax_total": "0.00",
"meta_data": []
}
],
"shipping_lines": [
{
"id": 317,
"method_title": "Flat Rate",
"method_id": "flat_rate",
"total": "10.00",
"total_tax": "0.00",
"taxes": [],
"meta_data": []
}
],
"fee_lines": [],
"coupon_lines": [],
"refunds": [],
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/orders/727"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/orders"
}
]
}
}
Retrieve an order
This API lets you retrieve and view a specific order.
HTTP request
GET
/wp-json/wc/v3/orders/<id>
curl https://example.com/wp-json/wc/v3/orders/727 \
-u consumer_key:consumer_secret
WooCommerce.get("orders/727")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('orders/727')); ?>
print(wcapi.get("orders/727").json())
woocommerce.get("orders/727").parsed_response
JSON response example:
{
"id": 727,
"parent_id": 0,
"number": "727",
"order_key": "wc_order_58d2d042d1d",
"created_via": "rest-api",
"version": "3.0.0",
"status": "processing",
"currency": "USD",
"date_created": "2019-03-22T16:28:02",
"date_created_gmt": "2019-03-22T19:28:02",
"date_modified": "2019-03-22T16:28:08",
"date_modified_gmt": "2019-03-22T19:28:08",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "10.00",
"shipping_tax": "0.00",
"cart_tax": "1.35",
"total": "29.35",
"total_tax": "1.35",
"prices_include_tax": false,
"customer_id": 0,
"customer_ip_address": "",
"customer_user_agent": "",
"customer_note": "",
"billing": {
"first_name": "John",
"last_name": "Doe",
"company": "",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US",
"email": "john.doe@example.com",
"phone": "(555) 555-5555"
},
"shipping": {
"first_name": "John",
"last_name": "Doe",
"company": "",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US"
},
"payment_method": "bacs",
"payment_method_title": "Direct Bank Transfer",
"transaction_id": "",
"date_paid": "2019-03-22T16:28:08",
"date_paid_gmt": "2019-03-22T19:28:08",
"date_completed": null,
"date_completed_gmt": null,
"cart_hash": "",
"meta_data": [
{
"id": 13106,
"key": "_download_permissions_granted",
"value": "yes"
}
],
"line_items": [
{
"id": 315,
"name": "Woo Single #1",
"product_id": 93,
"variation_id": 0,
"quantity": 2,
"tax_class": "",
"subtotal": "6.00",
"subtotal_tax": "0.45",
"total": "6.00",
"total_tax": "0.45",
"taxes": [
{
"id": 75,
"total": "0.45",
"subtotal": "0.45"
}
],
"meta_data": [],
"sku": "",
"price": 3,
"mi_inventories": [
{
"id": 180,
"inventory_id": 152,
"qty": 1,
"subtotal": 3,
"total": 3,
"refund_qty": 0,
"refund_total": 0
},
{
"id": 181,
"inventory_id": 126,
"qty": 1,
"subtotal": 3,
"total": 3,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": []
},
{
"id": 316,
"name": "Ship Your Idea – Color: Black, Size: M Test",
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"tax_class": "",
"subtotal": "12.00",
"subtotal_tax": "0.90",
"total": "12.00",
"total_tax": "0.90",
"taxes": [
{
"id": 75,
"total": "0.9",
"subtotal": "0.9"
}
],
"meta_data": [
{
"id": 2095,
"key": "pa_color",
"value": "black"
},
{
"id": 2096,
"key": "size",
"value": "M Test"
}
],
"sku": "Bar3",
"price": 12,
"mi_inventories": [
{
"id": 178,
"inventory_id": 83,
"qty": 1,
"subtotal": 12,
"total": 12,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": [
{
"bom_id": 184,
"bom_type": "product_part",
"qty": 6
}
]
}
],
"tax_lines": [
{
"id": 318,
"rate_code": "US-CA-STATE TAX",
"rate_id": 75,
"label": "State Tax",
"compound": false,
"tax_total": "1.35",
"shipping_tax_total": "0.00",
"meta_data": []
}
],
"shipping_lines": [
{
"id": 317,
"method_title": "Flat Rate",
"method_id": "flat_rate",
"total": "10.00",
"total_tax": "0.00",
"taxes": [],
"meta_data": []
}
],
"fee_lines": [],
"coupon_lines": [],
"refunds": [],
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/orders/727"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/orders"
}
]
}
}
Available parameters
| Parameter | Type | Description |
|---|---|---|
dp |
string | Number of decimal points to use in each resource. |
List all orders
This API helps you to view all the orders.
HTTP request
GET
/wp-json/wc/v3/orders
curl https://example.com/wp-json/wc/v3/orders \
-u consumer_key:consumer_secret
WooCommerce.get("orders")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('orders')); ?>
print(wcapi.get("orders").json())
woocommerce.get("orders").parsed_response
JSON response example:
[
{
"id": 727,
"parent_id": 0,
"number": "727",
"order_key": "wc_order_58d2d042d1d",
"created_via": "rest-api",
"version": "3.0.0",
"status": "processing",
"currency": "USD",
"date_created": "2019-03-22T16:28:02",
"date_created_gmt": "2019-03-22T19:28:02",
"date_modified": "2019-03-22T16:28:08",
"date_modified_gmt": "2019-03-22T19:28:08",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "10.00",
"shipping_tax": "0.00",
"cart_tax": "1.35",
"total": "29.35",
"total_tax": "1.35",
"prices_include_tax": false,
"customer_id": 0,
"customer_ip_address": "",
"customer_user_agent": "",
"customer_note": "",
"billing": {
"first_name": "John",
"last_name": "Doe",
"company": "",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US",
"email": "john.doe@example.com",
"phone": "(555) 555-5555"
},
"shipping": {
"first_name": "John",
"last_name": "Doe",
"company": "",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US"
},
"payment_method": "bacs",
"payment_method_title": "Direct Bank Transfer",
"transaction_id": "",
"date_paid": "2019-03-22T16:28:08",
"date_paid_gmt": "2019-03-22T19:28:08",
"date_completed": null,
"date_completed_gmt": null,
"cart_hash": "",
"meta_data": [
{
"id": 13106,
"key": "_download_permissions_granted",
"value": "yes"
},
{
"id": 13109,
"key": "_order_stock_reduced",
"value": "yes"
}
],
"line_items": [
{
"id": 315,
"name": "Woo Single #1",
"product_id": 93,
"variation_id": 0,
"quantity": 2,
"tax_class": "",
"subtotal": "6.00",
"subtotal_tax": "0.45",
"total": "6.00",
"total_tax": "0.45",
"taxes": [
{
"id": 75,
"total": "0.45",
"subtotal": "0.45"
}
],
"meta_data": [],
"sku": "",
"price": 3,
"mi_inventories": [
{
"id": 180,
"inventory_id": 152,
"qty": 1,
"subtotal": 3,
"total": 3,
"refund_qty": 0,
"refund_total": 0
},
{
"id": 181,
"inventory_id": 126,
"qty": 1,
"subtotal": 3,
"total": 3,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": []
},
{
"id": 316,
"name": "Ship Your Idea – Color: Black, Size: M Test",
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"tax_class": "",
"subtotal": "12.00",
"subtotal_tax": "0.90",
"total": "12.00",
"total_tax": "0.90",
"taxes": [
{
"id": 75,
"total": "0.9",
"subtotal": "0.9"
}
],
"meta_data": [
{
"id": 2095,
"key": "pa_color",
"value": "black"
},
{
"id": 2096,
"key": "size",
"value": "M Test"
}
],
"sku": "Bar3",
"price": 12,
"mi_inventories": [
{
"id": 178,
"inventory_id": 83,
"qty": 1,
"subtotal": 12,
"total": 12,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": [
{
"bom_id": 184,
"bom_type": "product_part",
"qty": 6
}
]
}
],
"tax_lines": [
{
"id": 318,
"rate_code": "US-CA-STATE TAX",
"rate_id": 75,
"label": "State Tax",
"compound": false,
"tax_total": "1.35",
"shipping_tax_total": "0.00",
"meta_data": []
}
],
"shipping_lines": [
{
"id": 317,
"method_title": "Flat Rate",
"method_id": "flat_rate",
"total": "10.00",
"total_tax": "0.00",
"taxes": [],
"meta_data": []
}
],
"fee_lines": [],
"coupon_lines": [],
"refunds": [],
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/orders/727"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/orders"
}
]
}
},
{
"id": 723,
"parent_id": 0,
"number": "723",
"order_key": "wc_order_58d17c18352",
"created_via": "checkout",
"version": "3.0.0",
"status": "completed",
"currency": "USD",
"date_created": "2019-03-21T16:16:00",
"date_created_gmt": "2019-03-21T19:16:00",
"date_modified": "2019-03-21T16:54:51",
"date_modified_gmt": "2019-03-21T19:54:51",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "10.00",
"shipping_tax": "0.00",
"cart_tax": "0.00",
"total": "39.00",
"total_tax": "0.00",
"prices_include_tax": false,
"customer_id": 26,
"customer_ip_address": "127.0.0.1",
"customer_user_agent": "mozilla/5.0 (x11; ubuntu; linux x86_64; rv:52.0) gecko/20100101 firefox/52.0",
"customer_note": "",
"billing": {
"first_name": "João",
"last_name": "Silva",
"company": "",
"address_1": "Av. Brasil, 432",
"address_2": "",
"city": "Rio de Janeiro",
"state": "RJ",
"postcode": "12345-000",
"country": "BR",
"email": "joao.silva@example.com",
"phone": "(11) 1111-1111"
},
"shipping": {
"first_name": "João",
"last_name": "Silva",
"company": "",
"address_1": "Av. Brasil, 432",
"address_2": "",
"city": "Rio de Janeiro",
"state": "RJ",
"postcode": "12345-000",
"country": "BR"
},
"payment_method": "bacs",
"payment_method_title": "Direct bank transfer",
"transaction_id": "",
"date_paid": null,
"date_paid_gmt": null,
"date_completed": "2019-03-21T16:54:51",
"date_completed_gmt": "2019-03-21T19:54:51",
"cart_hash": "5040ce7273261e31d8bcf79f9be3d279",
"meta_data": [
{
"id": 13023,
"key": "_download_permissions_granted",
"value": "yes"
}
],
"line_items": [
{
"id": 311,
"name": "Woo Album #2",
"product_id": 87,
"variation_id": 0,
"quantity": 1,
"tax_class": "",
"subtotal": "9.00",
"subtotal_tax": "0.00",
"total": "9.00",
"total_tax": "0.00",
"taxes": [],
"meta_data": [],
"sku": "",
"price": 9,
"mi_inventories": [],
"bom_items": []
},
{
"id": 313,
"name": "Woo Ninja",
"product_id": 34,
"variation_id": 0,
"quantity": 1,
"tax_class": "",
"subtotal": "20.00",
"subtotal_tax": "0.00",
"total": "20.00",
"total_tax": "0.00",
"taxes": [],
"meta_data": [],
"sku": "",
"price": 20,
"mi_inventories": [],
"bom_items": []
}
],
"tax_lines": [],
"shipping_lines": [
{
"id": 312,
"method_title": "Flat rate",
"method_id": "flat_rate:25",
"total": "10.00",
"total_tax": "0.00",
"taxes": [],
"meta_data": [
{
"id": 2057,
"key": "Items",
"value": "Woo Album #2 × 1"
}
]
}
],
"fee_lines": [],
"coupon_lines": [],
"refunds": [
{
"id": 726,
"refund": "",
"total": "-10.00"
},
{
"id": 724,
"refund": "",
"total": "-9.00"
}
],
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/orders/723"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/orders"
}
],
"customer": [
{
"href": "https://example.com/wp-json/wc/v3/customers/26"
}
]
}
}
]
Available parameters
| Parameter | Type | Description |
|---|---|---|
context |
string | Scope under which the request is made; determines fields present in response. Options: view and edit. Default is view. |
page |
integer | Current page of the collection. Default is 1. |
per_page |
integer | Maximum number of items to be returned in result set. Default is 10. |
search |
string | Limit results to those matching a string. |
after |
string | Limit response to resources published after a given ISO8601 compliant date. |
before |
string | Limit response to resources published before a given ISO8601 compliant date. |
modified_after |
string | Limit response to resources modified after a given ISO8601 compliant date. |
modified_before |
string | Limit response to resources modified before a given ISO8601 compliant date. |
exclude |
array | Ensure result set excludes specific IDs. |
include |
array | Limit result set to specific ids. |
offset |
integer | Offset the result set by a specific number of items. |
order |
string | Order sort attribute ascending or descending. Options: asc and desc. Default is desc. |
orderby |
string | Sort collection by object attribute. Options: date, id, include, title and slug. Default is date. |
parent |
array | Limit result set to those of particular parent IDs. |
parent_exclude |
array | Limit result set to all items except those of a particular parent ID. |
status |
array | Limit result set to orders assigned a specific status. Options: any, pending, processing, on-hold, completed, cancelled, refunded, failed and trash. Default is any. |
customer |
integer | Limit result set to orders assigned a specific customer. |
product |
integer | Limit result set to orders assigned a specific product. |
dp |
integer | Number of decimal points to use in each resource. Default is 2. |
Update an Order
This API lets you make changes to an order.
HTTP Request
PUT
/wp-json/wc/v3/orders/<id>
Example of updating Multi-Inventory's order items for a specific order item:
curl -X PUT https://example.com/wp-json/wc/v3/orders/727 \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"line_items": [
{
"id": 315,
"product_id": 93,
"mi_inventories": [
{
"inventory_id": 152,
"qty": 3
}
]
}
]
}'
const data = {
line_items: [
{
id: 315,
product_id: 93,
mi_inventories: [
{
inventory_id: 152,
qty: 3
}
]
}
]
};
WooCommerce.put("orders/727", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'line_items' => [
[
'id' => 315,
'product_id' => 93,
'mi_inventories' => [
[
'inventory_id' => 152,
'qty' => 3
]
]
]
]
];
print_r($woocommerce->put('orders/727', $data));
?>
data = {
"line_items": [
{
"id": 315,
"product_id": 93,
"mi_inventories": [
{
"inventory_id": 152,
"qty": 3
}
]
}
]
}
print(wcapi.put("orders/727", data).json())
data = {
line_items: [
{
id: 315,
product_id: 93,
mi_inventories: [
{
inventory_id: 152,
qty: 3
}
]
}
]
}
woocommerce.put("orders/727", data).parsed_response
JSON response example:
{
"id": 727,
"parent_id": 0,
"number": "727",
"order_key": "wc_order_58d2d042d1d",
"created_via": "rest-api",
"version": "3.0.0",
"status": "processing",
"currency": "USD",
"date_created": "2019-03-22T16:28:02",
"date_created_gmt": "2019-03-22T19:28:02",
"date_modified": "2019-03-22T16:30:35",
"date_modified_gmt": "2019-03-22T19:30:35",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "10.00",
"shipping_tax": "0.00",
"cart_tax": "1.35",
"total": "29.35",
"total_tax": "1.35",
"prices_include_tax": false,
"customer_id": 0,
"customer_ip_address": "",
"customer_user_agent": "",
"customer_note": "",
"billing": {
"first_name": "John",
"last_name": "Doe",
"company": "",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US",
"email": "john.doe@example.com",
"phone": "(555) 555-5555"
},
"shipping": {
"first_name": "John",
"last_name": "Doe",
"company": "",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US"
},
"payment_method": "bacs",
"payment_method_title": "Direct Bank Transfer",
"transaction_id": "",
"date_paid": "2019-03-22T16:28:08",
"date_paid_gmt": "2019-03-22T19:28:08",
"date_completed": "2019-03-22T16:30:35",
"date_completed_gmt": "2019-03-22T19:30:35",
"cart_hash": "",
"meta_data": [
{
"id": 13106,
"key": "_download_permissions_granted",
"value": "yes"
},
{
"id": 13109,
"key": "_order_stock_reduced",
"value": "yes"
}
],
"line_items": [
{
"id": 315,
"name": "Woo Single #1",
"product_id": 93,
"variation_id": 0,
"quantity": 2,
"tax_class": "",
"subtotal": "6.00",
"subtotal_tax": "0.45",
"total": "6.00",
"total_tax": "0.45",
"taxes": [
{
"id": 75,
"total": "0.45",
"subtotal": "0.45"
}
],
"meta_data": [],
"sku": "",
"price": 3,
"mi_inventories": [
{
"id": 180,
"inventory_id": 152,
"qty": 2,
"subtotal": 6,
"total": 6,
"refund_qty": 0,
"refund_total": 0
}
]
},
{
"id": 316,
"name": "Ship Your Idea – Color: Black, Size: M Test",
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"tax_class": "",
"subtotal": "12.00",
"subtotal_tax": "0.90",
"total": "12.00",
"total_tax": "0.90",
"taxes": [
{
"id": 75,
"total": "0.9",
"subtotal": "0.9"
}
],
"meta_data": [
{
"id": 2095,
"key": "pa_color",
"value": "black"
},
{
"id": 2096,
"key": "size",
"value": "M Test"
}
],
"sku": "Bar3",
"price": 12
}
],
"tax_lines": [
{
"id": 318,
"rate_code": "US-CA-STATE TAX",
"rate_id": 75,
"label": "State Tax",
"compound": false,
"tax_total": "1.35",
"shipping_tax_total": "0.00",
"meta_data": []
}
],
"shipping_lines": [
{
"id": 317,
"method_title": "Flat Rate",
"method_id": "flat_rate",
"total": "10.00",
"total_tax": "0.00",
"taxes": [],
"meta_data": []
}
],
"fee_lines": [],
"coupon_lines": [],
"refunds": [],
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/orders/727"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/orders"
}
]
}
}
Example of deleting a Multi-Inventory's order item from a specific order item and also deleting an order item:
curl -X PUT https://example.com/wp-json/wc/v3/orders/727 \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"line_items": [
{
"id": 315,
"product_id": 93,
"mi_inventories": [
{
"inventory_id": 152,
"delete": true
}
]
},
{
"id": 316,
"product_id": null
}
]
}'
const data = {
line_items: [
{
id: 315,
product_id: 93,
mi_inventories: [
{
inventory_id: 152,
delete: true
}
]
},
{
id: 316,
product_id: null
}
]
};
WooCommerce.put("orders/727", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'line_items' => [
[
'id' => 315,
'product_id' => 93,
'mi_inventories' => [
[
'inventory_id' => 152,
'delete' => true
]
]
],
[
'id' => 316,
'product_id' => null
]
]
];
print_r($woocommerce->put('orders/727', $data));
?>
data = {
"line_items": [
{
"id": 315,
"product_id": 93,
"mi_inventories": [
{
"inventory_id": 152,
"delete": true
}
]
},
{
"id": 316,
"product_id": null
}
]
}
print(wcapi.put("orders/727", data).json())
data = {
line_items: [
{
id: 315,
product_id: 93,
mi_inventories: [
{
inventory_id: 152,
delete: true
}
]
},
{
id: 316,
product_id: null
}
]
}
woocommerce.put("orders/727", data).parsed_response
JSON response example:
{
"id": 727,
"parent_id": 0,
"number": "727",
"order_key": "wc_order_58d2d042d1d",
"created_via": "rest-api",
"version": "3.0.0",
"status": "processing",
"currency": "USD",
"date_created": "2019-03-22T16:28:02",
"date_created_gmt": "2019-03-22T19:28:02",
"date_modified": "2019-03-22T16:30:35",
"date_modified_gmt": "2019-03-22T19:30:35",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "10.00",
"shipping_tax": "0.00",
"cart_tax": "1.35",
"total": "29.35",
"total_tax": "1.35",
"prices_include_tax": false,
"customer_id": 0,
"customer_ip_address": "",
"customer_user_agent": "",
"customer_note": "",
"billing": {
"first_name": "John",
"last_name": "Doe",
"company": "",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US",
"email": "john.doe@example.com",
"phone": "(555) 555-5555"
},
"shipping": {
"first_name": "John",
"last_name": "Doe",
"company": "",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US"
},
"payment_method": "bacs",
"payment_method_title": "Direct Bank Transfer",
"transaction_id": "",
"date_paid": "2019-03-22T16:28:08",
"date_paid_gmt": "2019-03-22T19:28:08",
"date_completed": "2019-03-22T16:30:35",
"date_completed_gmt": "2019-03-22T19:30:35",
"cart_hash": "",
"meta_data": [
{
"id": 13106,
"key": "_download_permissions_granted",
"value": "yes"
},
{
"id": 13109,
"key": "_order_stock_reduced",
"value": "yes"
}
],
"line_items": [
{
"id": 315,
"name": "Woo Single #1",
"product_id": 93,
"variation_id": 0,
"quantity": 2,
"tax_class": "",
"subtotal": "6.00",
"subtotal_tax": "0.45",
"total": "6.00",
"total_tax": "0.45",
"taxes": [
{
"id": 75,
"total": "0.45",
"subtotal": "0.45"
}
],
"meta_data": [],
"sku": "",
"price": 3,
"mi_inventories": []
}
],
"tax_lines": [
{
"id": 318,
"rate_code": "US-CA-STATE TAX",
"rate_id": 75,
"label": "State Tax",
"compound": false,
"tax_total": "1.35",
"shipping_tax_total": "0.00",
"meta_data": []
}
],
"shipping_lines": [
{
"id": 317,
"method_title": "Flat Rate",
"method_id": "flat_rate",
"total": "10.00",
"total_tax": "0.00",
"taxes": [],
"meta_data": []
}
],
"fee_lines": [],
"coupon_lines": [],
"refunds": [],
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/orders/727"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/orders"
}
]
}
}
Delete an order
This API helps you delete an order.
HTTP request
DELETE
/wp-json/wc/v3/orders/<id>
curl -X DELETE https://example.com/wp-json/wc/v3/orders/727?force=true \
-u consumer_key:consumer_secret
WooCommerce.delete("orders/727", {
force: true
})
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->delete('orders/727', ['force' => true])); ?>
print(wcapi.delete("orders/727", params={"force": True}).json())
woocommerce.delete("orders/727", force: true).parsed_response
JSON response example:
{
"id": 727,
"parent_id": 0,
"number": "727",
"order_key": "wc_order_58d2d042d1d",
"created_via": "rest-api",
"version": "3.0.0",
"status": "completed",
"currency": "USD",
"date_created": "2019-03-22T16:28:02",
"date_created_gmt": "2019-03-22T19:28:02",
"date_modified": "2019-03-22T16:30:35",
"date_modified_gmt": "2019-03-22T19:30:35",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "10.00",
"shipping_tax": "0.00",
"cart_tax": "1.35",
"total": "29.35",
"total_tax": "1.35",
"prices_include_tax": false,
"customer_id": 0,
"customer_ip_address": "",
"customer_user_agent": "",
"customer_note": "",
"billing": {
"first_name": "John",
"last_name": "Doe",
"company": "",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US",
"email": "john.doe@example.com",
"phone": "(555) 555-5555"
},
"shipping": {
"first_name": "John",
"last_name": "Doe",
"company": "",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US"
},
"payment_method": "bacs",
"payment_method_title": "Direct Bank Transfer",
"transaction_id": "",
"date_paid": "2019-03-22T16:28:08",
"date_paid_gmt": "2019-03-22T19:28:08",
"date_completed": "2019-03-22T16:30:35",
"date_completed_gmt": "2019-03-22T19:30:35",
"cart_hash": "",
"meta_data": [
{
"id": 13106,
"key": "_download_permissions_granted",
"value": "yes"
},
{
"id": 13109,
"key": "_order_stock_reduced",
"value": "yes"
}
],
"line_items": [
{
"id": 315,
"name": "Woo Single #1",
"product_id": 93,
"variation_id": 0,
"quantity": 2,
"tax_class": "",
"subtotal": "6.00",
"subtotal_tax": "0.45",
"total": "6.00",
"total_tax": "0.45",
"taxes": [
{
"id": 75,
"total": "0.45",
"subtotal": "0.45"
}
],
"meta_data": [],
"sku": "",
"price": 3,
"mi_inventories": [
{
"id": 180,
"inventory_id": 152,
"qty": 1,
"subtotal": 3,
"total": 3,
"refund_qty": 0,
"refund_total": 0
},
{
"id": 181,
"inventory_id": 126,
"qty": 1,
"subtotal": 3,
"total": 3,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": []
},
{
"id": 316,
"name": "Ship Your Idea – Color: Black, Size: M Test",
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"tax_class": "",
"subtotal": "12.00",
"subtotal_tax": "0.90",
"total": "12.00",
"total_tax": "0.90",
"taxes": [
{
"id": 75,
"total": "0.9",
"subtotal": "0.9"
}
],
"meta_data": [
{
"id": 2095,
"key": "pa_color",
"value": "black"
},
{
"id": 2096,
"key": "size",
"value": "M Test"
}
],
"sku": "Bar3",
"price": 12,
"mi_inventories": [
{
"id": 178,
"inventory_id": 83,
"qty": 1,
"subtotal": 12,
"total": 12,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": [
{
"bom_id": 184,
"bom_type": "product_part",
"qty": 6
}
]
}
],
"tax_lines": [
{
"id": 318,
"rate_code": "US-CA-STATE TAX",
"rate_id": 75,
"label": "State Tax",
"compound": false,
"tax_total": "1.35",
"shipping_tax_total": "0.00",
"meta_data": []
}
],
"shipping_lines": [
{
"id": 317,
"method_title": "Flat Rate",
"method_id": "flat_rate",
"total": "10.00",
"total_tax": "0.00",
"taxes": [],
"meta_data": []
}
],
"fee_lines": [],
"coupon_lines": [],
"refunds": [],
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/orders/727"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/orders"
}
]
}
}
Available parameters
| Parameter | Type | Description |
|---|---|---|
force |
string | Use true whether to permanently delete the order, Default is false. |
Batch update orders
This API helps you to batch create, update and delete multiple orders.
HTTP request
POST
/wp-json/wc/v3/orders/batch
Example of Create, Update and Delete items in bulk:
curl -X POST https://example.com/wp-json/wc/v3/orders/batch \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"create": [
{
"payment_method": "bacs",
"payment_method_title": "Direct Bank Transfer",
"billing": {
"first_name": "John",
"last_name": "Doe",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US",
"email": "john.doe@example.com",
"phone": "(555) 555-5555"
},
"shipping": {
"first_name": "John",
"last_name": "Doe",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US"
},
"line_items": [
{
"product_id": 79,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 13,
"qty": 1
}
]
},
{
"product_id": 93,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 14,
"qty": 1
}
]
},
{
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 58,
"qty": 1
}
]
}
],
"shipping_lines": [
{
"method_id": "flat_rate",
"method_title": "Flat Rate",
"total": 30
}
]
},
{
"payment_method": "bacs",
"payment_method_title": "Direct Bank Transfer",
"set_paid": true,
"billing": {
"first_name": "John",
"last_name": "Doe",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US",
"email": "john.doe@example.com",
"phone": "(555) 555-5555"
},
"shipping": {
"first_name": "John",
"last_name": "Doe",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US"
},
"line_items": [
{
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 59,
"qty": 1
}
]
},
{
"product_id": 22,
"variation_id": 24,
"quantity": 1
}
],
"shipping_lines": [
{
"method_id": "flat_rate",
"method_title": "Flat Rate",
"total": 20
}
]
}
],
"update": [
{
"id": 1936,
"line_items": [
{
"id": 715,
"product_id": 93,
"mi_inventories": [
{
"inventory_id": 152,
"qty": 3
}
]
}
]
}
],
"delete": [
723
]
}'
const data = {
create: [
{
payment_method: "bacs",
payment_method_title: "Direct Bank Transfer",
billing: {
first_name: "John",
last_name: "Doe",
address_1: "969 Market",
address_2: "",
city: "San Francisco",
state: "CA",
postcode: "94103",
country: "US",
email: "john.doe@example.com",
phone: "(555) 555-5555"
},
shipping: {
first_name: "John",
last_name: "Doe",
address_1: "969 Market",
address_2: "",
city: "San Francisco",
state: "CA",
postcode: "94103",
country: "US"
},
line_items: [
{
product_id: 79,
quantity: 1,
mi_inventories: [
{
inventory_id: 13,
qty: 1
}
]
},
{
product_id: 93,
quantity: 1,
mi_inventories: [
{
inventory_id: 14,
qty: 1
}
]
},
{
product_id: 22,
variation_id: 23,
quantity: 1,
mi_inventories: [
{
inventory_id: 58,
qty: 1
}
]
}
],
shipping_lines: [
{
method_id: "flat_rate",
method_title: "Flat Rate",
total: 30
}
]
},
{
payment_method: "bacs",
payment_method_title: "Direct Bank Transfer",
set_paid: true,
billing: {
first_name: "John",
last_name: "Doe",
address_1: "969 Market",
address_2: "",
city: "San Francisco",
state: "CA",
postcode: "94103",
country: "US",
email: "john.doe@example.com",
phone: "(555) 555-5555"
},
shipping: {
first_name: "John",
last_name: "Doe",
address_1: "969 Market",
address_2: "",
city: "San Francisco",
state: "CA",
postcode: "94103",
country: "US"
},
line_items: [
{
product_id: 22,
variation_id: 23,
quantity: 1,
mi_inventories: [
{
inventory_id: 59,
qty: 1
}
]
},
{
product_id: 22,
variation_id: 24,
quantity: 1
}
],
shipping_lines: [
{
method_id: "flat_rate",
method_title: "Flat Rate",
total: 20
}
]
}
],
update: [
{
id: 1936,
line_items: [
{
id: 715,
product_id: 93,
mi_inventories: [
{
inventory_id: 152,
qty: 3
}
]
}
]
}
],
delete: [
723
]
};
WooCommerce.post("orders/batch", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'create' => [
[
'payment_method' => 'bacs',
'payment_method_title' => 'Direct Bank Transfer',
'billing' => [
'first_name' => 'John',
'last_name' => 'Doe',
'address_1' => '969 Market',
'address_2' => '',
'city' => 'San Francisco',
'state' => 'CA',
'postcode' => '94103',
'country' => 'US',
'email' => 'john.doe@example.com',
'phone' => '(555) 555-5555'
],
'shipping' => [
'first_name' => 'John',
'last_name' => 'Doe',
'address_1' => '969 Market',
'address_2' => '',
'city' => 'San Francisco',
'state' => 'CA',
'postcode' => '94103',
'country' => 'US'
],
'line_items' => [
[
'product_id' => 79,
'quantity' => 1,
'mi_inventories' => [
[
'inventory_id' => 13,
'qty' => 1
]
]
],
[
'product_id' => 93,
'quantity' => 1,
'mi_inventories' => [
[
'inventory_id' => 14,
'qty' => 1
]
]
],
[
'product_id' => 22,
'variation_id' => 23,
'quantity' => 1,
'mi_inventories' => [
[
'inventory_id' => 58,
'qty' => 1
]
]
]
],
'shipping_lines' => [
[
'method_id' => 'flat_rate',
'method_title' => 'Flat Rate',
'total' => 30
]
]
],
[
'payment_method' => 'bacs',
'payment_method_title' => 'Direct Bank Transfer',
'set_paid' => true,
'billing' => [
'first_name' => 'John',
'last_name' => 'Doe',
'address_1' => '969 Market',
'address_2' => '',
'city' => 'San Francisco',
'state' => 'CA',
'postcode' => '94103',
'country' => 'US',
'email' => 'john.doe@example.com',
'phone' => '(555) 555-5555'
],
'shipping' => [
'first_name' => 'John',
'last_name' => 'Doe',
'address_1' => '969 Market',
'address_2' => '',
'city' => 'San Francisco',
'state' => 'CA',
'postcode' => '94103',
'country' => 'US'
],
'line_items' => [
[
'product_id' => 22,
'variation_id' => 23,
'quantity' => 1,
'mi_inventories' => [
[
'inventory_id' => 59,
'qty' => 1
]
]
],
[
'product_id' => 22,
'variation_id' => 24,
'quantity' => 1
]
],
'shipping_lines' => [
[
'method_id' => 'flat_rate',
'method_title' => 'Flat Rate',
'total' => 20
]
]
]
],
'update' => [
[
'id' => 1936,
'line_items' => [
[
'id' => 715,
'product_id' => 93,
'mi_inventories' => [
[
'inventory_id' => 152,
'qty' => 3
]
]
]
]
]
],
'delete' => [
723
]
];
print_r($woocommerce->post('orders/batch', $data));
?>
data = {
"create": [
{
"payment_method": "bacs",
"payment_method_title": "Direct Bank Transfer",
"billing": {
"first_name": "John",
"last_name": "Doe",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US",
"email": "john.doe@example.com",
"phone": "(555) 555-5555"
},
"shipping": {
"first_name": "John",
"last_name": "Doe",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US"
},
"line_items": [
{
"product_id": 79,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 13,
"qty": 1
}
]
},
{
"product_id": 93,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 14,
"qty": 1
}
]
},
{
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 58,
"qty": 1
}
]
}
],
"shipping_lines": [
{
"method_id": "flat_rate",
"method_title": "Flat Rate",
"total": 30
}
]
},
{
"payment_method": "bacs",
"payment_method_title": "Direct Bank Transfer",
"set_paid": True,
"billing": {
"first_name": "John",
"last_name": "Doe",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US",
"email": "john.doe@example.com",
"phone": "(555) 555-5555"
},
"shipping": {
"first_name": "John",
"last_name": "Doe",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US"
},
"line_items": [
{
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 59,
"qty": 1
}
]
},
{
"product_id": 22,
"variation_id": 24,
"quantity": 1
}
],
"shipping_lines": [
{
"method_id": "flat_rate",
"method_title": "Flat Rate",
"total": 20
}
]
}
],
"update": [
{
"id": 1936,
"line_items": [
{
"id": 715,
"product_id": 93,
"mi_inventories": [
{
"inventory_id": 152,
"qty": 3
}
]
}
]
}
],
"delete": [
723
]
}
print(wcapi.post("orders/batch", data).json())
data = {
create: [
{
payment_method: "bacs",
payment_method_title: "Direct Bank Transfer",
billing: {
first_name: "John",
last_name: "Doe",
address_1: "969 Market",
address_2: "",
city: "San Francisco",
state: "CA",
postcode: "94103",
country: "US",
email: "john.doe@example.com",
phone: "(555) 555-5555"
},
shipping: {
first_name: "John",
last_name: "Doe",
address_1: "969 Market",
address_2: "",
city: "San Francisco",
state: "CA",
postcode: "94103",
country: "US"
},
line_items: [
{
product_id: 79,
quantity: 1,
mi_inventories: [
{
inventory_id: 13,
qty: 1
}
]
},
{
product_id: 93,
quantity: 1,
mi_inventories: [
{
inventory_id: 14,
qty: 1
}
]
},
{
product_id: 22,
variation_id: 23,
quantity: 1,
mi_inventories: [
{
inventory_id: 58,
qty: 1
}
]
}
],
shipping_lines: [
{
method_id: "flat_rate",
method_title: "Flat Rate",
total: 30
}
]
},
{
payment_method: "bacs",
payment_method_title: "Direct Bank Transfer",
set_paid: true,
billing: {
first_name: "John",
last_name: "Doe",
address_1: "969 Market",
address_2: "",
city: "San Francisco",
state: "CA",
postcode: "94103",
country: "US",
email: "john.doe@example.com",
phone: "(555) 555-5555"
},
shipping: {
first_name: "John",
last_name: "Doe",
address_1: "969 Market",
address_2: "",
city: "San Francisco",
state: "CA",
postcode: "94103",
country: "US"
},
line_items: [
{
product_id: 22,
variation_id: 23,
quantity: 1,
mi_inventories: [
{
inventory_id: 59,
qty: 1
}
]
},
{
product_id: 22,
variation_id: 24,
quantity: 1
}
],
shipping_lines: [
{
method_id: "flat_rate",
method_title: "Flat Rate",
total: 20
}
]
}
],
update: [
{
id: 1936,
line_items: [
{
id: 715,
product_id: 93,
mi_inventories: [
{
inventory_id: 152,
qty: 3
}
]
}
]
}
],
delete: [
723
]
}
woocommerce.post("orders/batch", data).parsed_response
JSON response example:
{
"create": [
{
"id": 1990,
"parent_id": 0,
"number": "728",
"order_key": "wc_order_58d2d18e580",
"created_via": "rest-api",
"version": "3.0.0",
"status": "pending",
"currency": "USD",
"date_created": "2019-03-22T16:33:34",
"date_created_gmt": "2019-03-22T19:33:34",
"date_modified": "2019-03-22T16:33:34",
"date_modified_gmt": "2019-03-22T19:33:34",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "30.00",
"shipping_tax": "0.00",
"cart_tax": "2.25",
"total": "62.25",
"total_tax": "2.25",
"prices_include_tax": false,
"customer_id": 0,
"customer_ip_address": "",
"customer_user_agent": "",
"customer_note": "",
"billing": {
"first_name": "John",
"last_name": "Doe",
"company": "",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US",
"email": "john.doe@example.com",
"phone": "(555) 555-5555"
},
"shipping": {
"first_name": "John",
"last_name": "Doe",
"company": "",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US"
},
"payment_method": "bacs",
"payment_method_title": "Direct Bank Transfer",
"transaction_id": "",
"date_paid": null,
"date_paid_gmt": null,
"date_completed": null,
"date_completed_gmt": null,
"cart_hash": "",
"meta_data": [],
"line_items": [
{
"id": 319,
"name": "Woo Logo",
"product_id": 79,
"variation_id": 0,
"quantity": 1,
"tax_class": "",
"subtotal": "15.00",
"subtotal_tax": "1.13",
"total": "15.00",
"total_tax": "1.13",
"taxes": [
{
"id": 75,
"total": "1.125",
"subtotal": "1.125"
}
],
"meta_data": [],
"sku": "",
"price": 15,
"mi_inventories": [
{
"id": 180,
"inventory_id": 13,
"qty": 1,
"subtotal": 15,
"total": 15,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": []
},
{
"id": 320,
"name": "Woo Single #1",
"product_id": 93,
"variation_id": 0,
"quantity": 1,
"tax_class": "",
"subtotal": "3.00",
"subtotal_tax": "0.23",
"total": "3.00",
"total_tax": "0.23",
"taxes": [
{
"id": 75,
"total": "0.225",
"subtotal": "0.225"
}
],
"meta_data": [],
"sku": "",
"price": 3,
"mi_inventories": [
{
"id": 181,
"inventory_id": 14,
"qty": 1,
"subtotal": 3,
"total": 3,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": []
},
{
"id": 321,
"name": "Ship Your Idea – Color: Black, Size: M Test",
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"tax_class": "",
"subtotal": "12.00",
"subtotal_tax": "0.90",
"total": "12.00",
"total_tax": "0.90",
"taxes": [
{
"id": 75,
"total": "0.9",
"subtotal": "0.9"
}
],
"meta_data": [
{
"id": 2133,
"key": "pa_color",
"value": "black"
},
{
"id": 2134,
"key": "size",
"value": "M Test"
}
],
"sku": "Bar3",
"price": 12,
"mi_inventories": [
{
"id": 182,
"inventory_id": 58,
"qty": 1,
"subtotal": 12,
"total": 12,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": []
}
],
"tax_lines": [
{
"id": 323,
"rate_code": "US-CA-STATE TAX",
"rate_id": 75,
"label": "State Tax",
"compound": false,
"tax_total": "2.25",
"shipping_tax_total": "0.00",
"meta_data": []
}
],
"shipping_lines": [
{
"id": 322,
"method_title": "Flat Rate",
"method_id": "flat_rate",
"total": "30.00",
"total_tax": "0.00",
"taxes": [],
"meta_data": []
}
],
"fee_lines": [],
"coupon_lines": [],
"refunds": [],
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/orders/728"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/orders"
}
]
}
},
{
"id": 1991,
"parent_id": 0,
"number": "729",
"order_key": "wc_order_58d2d196171",
"created_via": "rest-api",
"version": "3.0.0",
"status": "processing",
"currency": "USD",
"date_created": "2019-03-22T16:33:42",
"date_created_gmt": "2019-03-22T19:33:42",
"date_modified": "2019-03-22T16:33:47",
"date_modified_gmt": "2019-03-22T19:33:47",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "20.00",
"shipping_tax": "0.00",
"cart_tax": "2.40",
"total": "54.40",
"total_tax": "2.40",
"prices_include_tax": false,
"customer_id": 0,
"customer_ip_address": "",
"customer_user_agent": "",
"customer_note": "",
"billing": {
"first_name": "John",
"last_name": "Doe",
"company": "",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US",
"email": "john.doe@example.com",
"phone": "(555) 555-5555"
},
"shipping": {
"first_name": "John",
"last_name": "Doe",
"company": "",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US"
},
"payment_method": "bacs",
"payment_method_title": "Direct Bank Transfer",
"transaction_id": "",
"date_paid": "2019-03-22T16:33:47",
"date_paid_gmt": "2019-03-22T19:33:47",
"date_completed": null,
"date_completed_gmt": null,
"cart_hash": "",
"meta_data": [
{
"id": 13198,
"key": "_download_permissions_granted",
"value": "yes"
}
],
"line_items": [
{
"id": 324,
"name": "Ship Your Idea – Color: Black, Size: M Test",
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"tax_class": "",
"subtotal": "12.00",
"subtotal_tax": "0.90",
"total": "12.00",
"total_tax": "0.90",
"taxes": [
{
"id": 75,
"total": "0.9",
"subtotal": "0.9"
}
],
"meta_data": [
{
"id": 2153,
"key": "pa_color",
"value": "black"
},
{
"id": 2154,
"key": "size",
"value": "M Test"
}
],
"sku": "Bar3",
"price": 12,
"mi_inventories": [
{
"id": 183,
"inventory_id": 59,
"qty": 1,
"subtotal": 12,
"total": 12,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": []
},
{
"id": 325,
"name": "Ship Your Idea – Color: Green, Size: S Test",
"product_id": 22,
"variation_id": 24,
"quantity": 1,
"tax_class": "",
"subtotal": "20.00",
"subtotal_tax": "1.50",
"total": "20.00",
"total_tax": "1.50",
"taxes": [
{
"id": 75,
"total": "1.5",
"subtotal": "1.5"
}
],
"meta_data": [
{
"id": 2164,
"key": "pa_color",
"value": "green"
},
{
"id": 2165,
"key": "size",
"value": "S Test"
}
],
"sku": "",
"price": 20,
"mi_inventories": [],
"bom_items": []
}
],
"tax_lines": [
{
"id": 327,
"rate_code": "US-CA-STATE TAX",
"rate_id": 75,
"label": "State Tax",
"compound": false,
"tax_total": "2.40",
"shipping_tax_total": "0.00",
"meta_data": []
}
],
"shipping_lines": [
{
"id": 326,
"method_title": "Flat Rate",
"method_id": "flat_rate",
"total": "20.00",
"total_tax": "0.00",
"taxes": [],
"meta_data": []
}
],
"fee_lines": [],
"coupon_lines": [],
"refunds": [],
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/orders/729"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/orders"
}
]
}
}
],
"update": [
{
"id": 1936,
"parent_id": 0,
"number": "727",
"order_key": "wc_order_58d2d042d1d",
"created_via": "rest-api",
"version": "3.0.0",
"status": "completed",
"currency": "USD",
"date_created": "2019-03-22T16:28:02",
"date_created_gmt": "2019-03-22T19:28:02",
"date_modified": "2019-03-22T16:30:35",
"date_modified_gmt": "2019-03-22T19:30:35",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "10.00",
"shipping_tax": "0.00",
"cart_tax": "1.35",
"total": "29.35",
"total_tax": "1.35",
"prices_include_tax": false,
"customer_id": 0,
"customer_ip_address": "",
"customer_user_agent": "",
"customer_note": "",
"billing": {
"first_name": "John",
"last_name": "Doe",
"company": "",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US",
"email": "john.doe@example.com",
"phone": "(555) 555-5555"
},
"shipping": {
"first_name": "John",
"last_name": "Doe",
"company": "",
"address_1": "969 Market",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"postcode": "94103",
"country": "US"
},
"payment_method": "bacs",
"payment_method_title": "Direct Bank Transfer",
"transaction_id": "",
"date_paid": "2019-03-22T16:28:08",
"date_paid_gmt": "2019-03-22T19:28:08",
"date_completed": "2019-03-22T16:30:35",
"date_completed_gmt": "2019-03-22T19:30:35",
"cart_hash": "",
"meta_data": [
{
"id": 13106,
"key": "_download_permissions_granted",
"value": "yes"
},
{
"id": 13109,
"key": "_order_stock_reduced",
"value": "yes"
}
],
"line_items": [
{
"id": 715,
"name": "Woo Single #1",
"product_id": 93,
"variation_id": 0,
"quantity": 2,
"tax_class": "",
"subtotal": "18.00",
"subtotal_tax": "0.45",
"total": "18.00",
"total_tax": "0.45",
"taxes": [
{
"id": 75,
"total": "0.45",
"subtotal": "0.45"
}
],
"meta_data": [],
"sku": "",
"price": 3,
"mi_inventories": [
{
"id": 191,
"inventory_id": 152,
"qty": 3,
"subtotal": 18,
"total": 18,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": []
},
{
"id": 316,
"name": "Ship Your Idea – Color: Black, Size: M Test",
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"tax_class": "",
"subtotal": "12.00",
"subtotal_tax": "0.90",
"total": "12.00",
"total_tax": "0.90",
"taxes": [
{
"id": 75,
"total": "0.9",
"subtotal": "0.9"
}
],
"meta_data": [
{
"id": 2095,
"key": "pa_color",
"value": "black"
},
{
"id": 2096,
"key": "size",
"value": "M Test"
}
],
"sku": "Bar3",
"price": 12,
"mi_inventories": [],
"bom_items": []
}
],
"tax_lines": [
{
"id": 318,
"rate_code": "US-CA-STATE TAX",
"rate_id": 75,
"label": "State Tax",
"compound": false,
"tax_total": "1.35",
"shipping_tax_total": "0.00",
"meta_data": []
}
],
"shipping_lines": [
{
"id": 317,
"method_title": "Flat Rate",
"method_id": "flat_rate",
"total": "10.00",
"total_tax": "0.00",
"taxes": [],
"meta_data": []
}
],
"fee_lines": [],
"coupon_lines": [],
"refunds": [],
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/orders/727"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/orders"
}
]
}
}
],
"delete": [
{
"id": 723,
"parent_id": 0,
"number": "723",
"order_key": "wc_order_58d17c18352",
"created_via": "checkout",
"version": "3.0.0",
"status": "completed",
"currency": "USD",
"date_created": "2019-03-21T16:16:00",
"date_created_gmt": "2019-03-21T19:16:00",
"date_modified": "2019-03-21T16:54:51",
"date_modified_gmt": "2019-03-21T19:54:51",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "10.00",
"shipping_tax": "0.00",
"cart_tax": "0.00",
"total": "39.00",
"total_tax": "0.00",
"prices_include_tax": false,
"customer_id": 26,
"customer_ip_address": "127.0.0.1",
"customer_user_agent": "mozilla/5.0 (x11; ubuntu; linux x86_64; rv:52.0) gecko/20100101 firefox/52.0",
"customer_note": "",
"billing": {
"first_name": "João",
"last_name": "Silva",
"company": "",
"address_1": "Av. Brasil, 432",
"address_2": "",
"city": "Rio de Janeiro",
"state": "RJ",
"postcode": "12345-000",
"country": "BR",
"email": "joao.silva@example.com",
"phone": "(11) 1111-1111"
},
"shipping": {
"first_name": "João",
"last_name": "Silva",
"company": "",
"address_1": "Av. Brasil, 432",
"address_2": "",
"city": "Rio de Janeiro",
"state": "RJ",
"postcode": "12345-000",
"country": "BR"
},
"payment_method": "bacs",
"payment_method_title": "Direct bank transfer",
"transaction_id": "",
"date_paid": null,
"date_paid_gmt": null,
"date_completed": "2019-03-21T16:54:51",
"date_completed_gmt": "2019-03-21T19:54:51",
"cart_hash": "5040ce7273261e31d8bcf79f9be3d279",
"meta_data": [
{
"id": 13023,
"key": "_download_permissions_granted",
"value": "yes"
}
],
"line_items": [
{
"id": 311,
"name": "Woo Album #2",
"product_id": 87,
"variation_id": 0,
"quantity": 1,
"tax_class": "",
"subtotal": "9.00",
"subtotal_tax": "0.00",
"total": "9.00",
"total_tax": "0.00",
"taxes": [],
"meta_data": [],
"sku": "",
"price": 9,
"mi_inventories": [],
"bom_items": []
},
{
"id": 313,
"name": "Woo Ninja",
"product_id": 34,
"variation_id": 0,
"quantity": 1,
"tax_class": "",
"subtotal": "20.00",
"subtotal_tax": "0.00",
"total": "20.00",
"total_tax": "0.00",
"taxes": [],
"meta_data": [],
"sku": "",
"price": 20,
"mi_inventories": [],
"bom_items": []
}
],
"tax_lines": [],
"shipping_lines": [
{
"id": 312,
"method_title": "Flat rate",
"method_id": "flat_rate:25",
"total": "10.00",
"total_tax": "0.00",
"taxes": [],
"meta_data": [
{
"id": 2057,
"key": "Items",
"value": "Woo Album #2 × 1"
}
]
}
],
"fee_lines": [],
"coupon_lines": [],
"refunds": [
{
"id": 726,
"refund": "",
"total": "-10.00"
},
{
"id": 724,
"refund": "",
"total": "-9.00"
}
],
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/orders/723"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/orders"
}
],
"customer": [
{
"href": "https://example.com/wp-json/wc/v3/customers/26"
}
]
}
}
]
}
Products
This endpoint is an extension of the official WC's orders enndpoint with extra info added by ATUM and/or its add-ons. You can identify the ATUM data with the corresponding labels.
The products API allows you to create, view, update, and delete individual, or a batch, of products.
Product properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Unique identifier for the resource. read-only |
name |
string | Product name. |
slug |
string | Product slug. |
permalink |
string | Product URL. read-only |
date_created |
date-time | The date the product was created, in the site's timezone. read-only |
date_created_gmt |
date-time | The date the product was created, as GMT. read-only |
date_modified |
date-time | The date the product was last modified, in the site's timezone. read-only |
date_modified_gmt |
date-time | The date the product was last modified, as GMT. read-only |
type |
string | Product type. Options: simple, grouped, external, variable, product-part, raw-material, variable-product-part and variable-raw-material. Default is simple. |
status |
string | Product status (post status). Options: draft, pending, private and publish. Default is publish. |
featured |
boolean | Featured product. Default is false. |
catalog_visibility |
string | Catalog visibility. Options: visible, catalog, search and hidden. Default is visible. |
description |
string | Product description. |
short_description |
string | Product short description. |
sku |
string | Unique identifier. |
price |
string | Current product price. read-only |
regular_price |
string | Product regular price. |
sale_price |
string | Product sale price. |
date_on_sale_from |
date-time | Start date of sale price, in the site's timezone. |
date_on_sale_from_gmt |
date-time | Start date of sale price, as GMT. |
date_on_sale_to |
date-time | End date of sale price, in the site's timezone. |
date_on_sale_to_gmt |
date-time | End date of sale price, as GMT. |
price_html |
string | Price formatted in HTML. read-only |
on_sale |
boolean | Shows if the product is on sale. read-only |
purchasable |
boolean | Shows if the product can be bought. read-only |
total_sales |
integer | Amount of sales. read-only |
virtual |
boolean | If the product is virtual. Default is false. |
downloadable |
boolean | If the product is downloadable. Default is false. |
downloads |
array | List of downloadable files. See Product - Downloads properties |
download_limit |
integer | Number of times downloadable files can be downloaded after purchase. Default is -1. |
download_expiry |
integer | Number of days until access to downloadable files expires. Default is -1. |
external_url |
string | Product external URL. Only for external products. |
button_text |
string | Product external button text. Only for external products. |
tax_status |
string | Tax status. Options: taxable, shipping and none. Default is taxable. |
tax_class |
string | Tax class. |
manage_stock |
boolean | Stock management at product level. Default is false. |
stock_quantity |
integer | Stock quantity. |
stock_status |
string | Controls the stock status of the product. Options: instock, outofstock, onbackorder. Default is instock. |
backorders |
string | If managing stock, this controls if backorders are allowed. Options: no, notify and yes. Default is no. |
backorders_allowed |
boolean | Shows if backorders are allowed. read-only |
backordered |
boolean | Shows if the product is on backordered. read-only |
sold_individually |
boolean | Allow one item to be bought in a single order. Default is false. |
weight |
string | Product weight. |
dimensions |
object | Product dimensions. See Product - Dimensions properties |
shipping_required |
boolean | Shows if the product need to be shipped. read-only |
shipping_taxable |
boolean | Shows whether or not the product shipping is taxable. read-only |
shipping_class |
string | Shipping class slug. |
shipping_class_id |
integer | Shipping class ID. read-only |
reviews_allowed |
boolean | Allow reviews. Default is true. |
average_rating |
string | Reviews average rating. read-only |
rating_count |
integer | Amount of reviews that the product have. read-only |
related_ids |
array | List of related products IDs. read-only |
upsell_ids |
array | List of up-sell products IDs. |
cross_sell_ids |
array | List of cross-sell products IDs. |
parent_id |
integer | Product parent ID. |
purchase_note |
string | Optional note to send the customer after purchase. |
categories |
array | List of categories. See Product - Categories properties |
tags |
array | List of tags. See Product - Tags properties |
images |
array | List of images. See Product - Images properties |
attributes |
array | List of attributes. See Product - Attributes properties |
default_attributes |
array | Defaults variation attributes. See Product - Default attributes properties |
variations |
array | List of variations IDs. read-only |
grouped_products |
array | List of grouped products ID. |
menu_order |
integer | Menu order, used to custom sort products. |
meta_data |
array | Meta data. See Product - Meta data properties |
purchase_price |
number | Product's purchase price. ATUM |
supplier_id |
integer | The ID of the ATUM Supplier that is linked to this product. ATUM |
supplier_sku |
string | The Supplier's SKU for this product. ATUM |
barcode |
string | The barcode for this product. ATUM |
atum_controlled |
boolean | Whether this product is being controlled by ATUM. Default is false. ATUM |
out_stock_date |
date-time | The date when this product run out of stock. ATUM |
out_stock_threshold |
number | Out of stock threshold at product level. ATUM |
inheritable |
boolean | Whether this product may have children. Default is false. ATUM |
inbound_stock |
number | Product's inbound stock. ATUM |
stock_on_hold |
number | Product's stock on hold. ATUM |
sold_today |
number | Units sold today. ATUM |
sales_last_days |
number | Sales the last 14 days. ATUM |
reserved_stock |
number | Stock set as 'reserved_stock' within Inventory Logs. ATUM |
customer_returns |
number | Stock set as 'customer returns' within Inventory Logs. ATUM |
warehouse_damage |
number | Stock set as 'warehouse damage' within Inventory Logs. ATUM |
lost_in_post |
number | Stock set as 'lost in post' within Inventory Logs. ATUM |
other_logs |
number | Stock set as 'other' within Inventory Logs. ATUM |
out_stock_days |
integer | The number of days that the product is Out of stock. ATUM |
lost_sales |
number | Product lost sales. ATUM |
has_location |
boolean | Whether this product has any ATUM location set. ATUM |
update_date |
date-time | Last date when the ATUM product data was calculated and saved for this product. ATUM |
atum_locations |
array | List of categories. See Product - ATUM locations properties ATUM |
mi_inventories |
array | An array of inventory IDs linked to the product (if any). Multi-Inventory ATUM read-only |
multi_inventory |
string | The Multi Inventory status for this product. Options: yes, no, global. Multi-Inventory ATUM |
inventory_sorting_mode |
string | The sorting mode specified for inventory selling priority. Options: fifo, lifo, bbe, manual, global. Multi-Inventory ATUM |
inventory_iteration |
string | What to do when the first selling inventory runs out of stock. Options: use_next, out_of_stock, global. Multi-Inventory ATUM |
expirable_inventories |
string | Set the inventories as 'Out of Stock' when reaching their BBE dates. Options: yes, no, global. Multi-Inventory ATUM |
price_per_inventory |
string | Allow distinct inventories to have distinct prices. Options: yes, no, global. Multi-Inventory ATUM |
selectable_inventories |
string | Whether the selectable inventories is enabled. Options: yes, no, global. Multi-Inventory ATUM |
selectable_inventories_mode |
string | The inventory selection mode for the frontend display. Options: dropdown, list, global. Multi-Inventory ATUM |
linked_bom |
array | The BOM linked to the product with their quantities. See Product - Linked BOM properties Product Levels ATUM |
bom_sellable |
array | If the product is a BOM, indicates whether the product is sellable. Product Levels ATUM |
minimum_threshold |
number | If the product is a BOM, indicates the product's minimum threshold. Product Levels ATUM |
available_to_purchase |
number | If the product is a BOM, indicates the product's available to purchase amount. Product Levels ATUM |
selling_priority |
integer | If the product is a BOM, indicates the product's selling priority. Product Levels ATUM |
calculated_stock |
number | If the BOM stock control is enabled and the product has linked BOM, it indicates the calculated stock quantity. Product Levels ATUM |
sync_purchase_price |
boolean | Whether to sync the product's purchase price with the BOM's purchase price. Default is false, Product Levels ATUM |
Product - Downloads properties
| Attribute | Type | Description |
|---|---|---|
id |
string | File ID. |
name |
string | File name. |
file |
string | File URL. |
Product - Dimensions properties
| Attribute | Type | Description |
|---|---|---|
length |
string | Product length. |
width |
string | Product width. |
height |
string | Product height. |
Product - Categories properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Category ID. |
name |
string | Category name. read-only |
slug |
string | Category slug. read-only |
Product - Tags properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Tag ID. |
name |
string | Tag name. read-only |
slug |
string | Tag slug. read-only |
Product - Images properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Image ID. |
date_created |
date-time | The date the image was created, in the site's timezone. read-only |
date_created_gmt |
date-time | The date the image was created, as GMT. read-only |
date_modified |
date-time | The date the image was last modified, in the site's timezone. read-only |
date_modified_gmt |
date-time | The date the image was last modified, as GMT. read-only |
src |
string | Image URL. |
name |
string | Image name. |
alt |
string | Image alternative text. |
Product - Attributes properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Attribute ID. |
name |
string | Attribute name. |
position |
integer | Attribute position. |
visible |
boolean | Define if the attribute is visible on the "Additional information" tab in the product's page. Default is false. |
variation |
boolean | Define if the attribute can be used as variation. Default is false. |
options |
array | List of available term names of the attribute. |
Product - Default attributes properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Attribute ID. |
name |
string | Attribute name. |
option |
string | Selected attribute term name. |
Product - Meta data properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Meta ID. read-only |
key |
string | Meta key. |
value |
string | Meta value. |
Product - ATUM locations properties ATUM
| Attribute | Type | Description |
|---|---|---|
id |
integer | Location ID. |
name |
string | Location name. read-only |
slug |
string | Location slug. read-only |
Product - Linked BOM properties ATUM Product Levels
| Attribute | Type | Description |
|---|---|---|
bom_id |
integer | The linked BOM product ID. |
bom_type |
string | The linked BOM product type. Options: raw_material, product_part |
qty |
number | The linked BOM quantity. |
delete |
boolean | Whether to delete the linked BOM from the product. write-only |
Create a product
This API helps you to create a new product.
HTTP request
POST
/wp-json/wc/v3/products
Example of how to create a
simpleproduct with ATUM data:
curl -X POST https://example.com/wp-json/wc/v3/products \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"name": "ATUM Test Product",
"type": "simple",
"regular_price": "21.99",
"purchase_price": 15.2,
"supplier_id": 399,
"supplier_sku": "TEST1",
"barcode": "AAAAAABBBBBB",
"atum_controlled": true,
"linked_bom": [
{
"bom_id": 175,
"bom_type": "product_part",
"qty": 3
}
],
"atum_locations": [
{
"id": 39
},
{
"id": 37
}
],
"description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
"short_description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.",
"categories": [
{
"id": 9
},
{
"id": 14
}
],
"images": [
{
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_front.jpg"
},
{
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_back.jpg"
}
]
}'
const data = {
name: "ATUM Test Product",
type: "simple",
regular_price: "21.99",
purchase_price: 15.2,
supplier_id: 399,
supplier_sku: "TEST1",
barcode: "AAAAAABBBBBB",
atum_controlled: true,
linked_bom: [
{
bom_id: 175,
bom_type: "product_part",
qty: 3
}
],
atum_locations: [
{
id: 39
},
{
id: 37
}
],
description: "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
short_description: "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.",
categories: [
{
id: 9
},
{
id: 14
}
],
images: [
{
src: "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_front.jpg"
},
{
src: "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_back.jpg"
}
]
};
WooCommerce.post("products", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'name' => 'ATUM Test Product',
'type' => 'simple',
'regular_price' => '21.99',
'purchase_price' => 15.2,
'supplier_id' => 399,
'supplier_sku' => 'TEST1',
'barcode' => 'AAAAAABBBBBB',
'atum_controlled' => true,
'linked_bom' => [
[
'bom_id' => 175,
'bom_type' => 'product_part',
'qty' => 3
]
],
'atum_locations' => [
[
'id' => 39
],
[
'id' => 37
]
],
'description' => 'Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.',
'short_description' => 'Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.',
'categories' => [
[
'id' => 9
],
[
'id' => 14
]
],
'images' => [
[
'src' => 'http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_front.jpg'
],
[
'src' => 'http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_back.jpg'
]
]
];
print_r($woocommerce->post('products', $data));
?>
data = {
"name": "ATUM Test Product",
"type": "simple",
"regular_price": "21.99",
"purchase_price": 15.2,
"supplier_id": 399,
"supplier_sku": "TEST1",
"barcode": "AAAAAABBBBBB",
"atum_controlled": true,
"linked_bom": [
{
"bom_id": 175,
"bom_type": "product_part",
"qty": 3
}
],
"atum_locations": [
{
"id": 39
},
{
"id": 37
}
],
"description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
"short_description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.",
"categories": [
{
"id": 9
},
{
"id": 14
}
],
"images": [
{
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_front.jpg"
},
{
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_back.jpg"
}
]
}
print(wcapi.post("products", data).json())
data = {
name: "ATUM Test Product",
type: "simple",
regular_price: "21.99",
purchase_price: 15.2,
supplier_id: 399,
supplier_sku: "TEST1",
barcode: "AAAAAABBBBBB",
atum_controlled: true,
linked_bom: [
{
bom_id: 175,
bom_type: "product_part",
qty: 3
}
],
atum_locations: [
{
id: 39
},
{
id: 37
}
],
description: "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
short_description: "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.",
categories: [
{
id: 9
},
{
id: 14
}
],
images: [
{
src: "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_front.jpg"
},
{
src: "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_back.jpg",
}
]
}
woocommerce.post("products", data).parsed_response
JSON response example:
{
"id": 1998,
"name": "ATUM Test Product",
"slug": "atum-test-product",
"permalink": "https://example.com/product/atum-test-product/",
"date_created": "2019-11-06T08:54:04",
"date_created_gmt": "2019-11-06T07:54:04",
"date_modified": "2019-11-06T08:54:04",
"date_modified_gmt": "2019-11-06T07:54:04",
"type": "simple",
"status": "publish",
"featured": false,
"catalog_visibility": "visible",
"description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
"short_description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.",
"sku": "",
"price": "21.99",
"regular_price": "21.99",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"price_html": "<span class=\"woocommerce-Price-amount amount\"><span class=\"woocommerce-Price-currencySymbol\">€</span>21,99</span>",
"on_sale": false,
"purchasable": true,
"total_sales": 0,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"external_url": "",
"button_text": "",
"tax_status": "taxable",
"tax_class": "",
"manage_stock": false,
"stock_quantity": null,
"stock_status": "instock",
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"sold_individually": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_required": true,
"shipping_taxable": true,
"shipping_class": "",
"shipping_class_id": 0,
"reviews_allowed": true,
"average_rating": "0",
"rating_count": 0,
"related_ids": [
37,
103,
60,
19,
15
],
"upsell_ids": [],
"cross_sell_ids": [],
"parent_id": 0,
"purchase_note": "",
"categories": [
{
"id": 9,
"name": "Clothing",
"slug": "clothing"
},
{
"id": 14,
"name": "T-shirts",
"slug": "t-shirts"
}
],
"tags": [],
"images": [
{
"id": 1996,
"date_created": "2019-11-06T09:54:03",
"date_created_gmt": "2019-11-06T07:54:03",
"date_modified": "2019-11-06T09:54:03",
"date_modified_gmt": "2019-11-06T07:54:03",
"src": "https://example.com/wp-content/uploads/2019/11/T_2_front-8.jpg",
"name": "T_2_front-8.jpg",
"alt": ""
},
{
"id": 1997,
"date_created": "2019-11-06T09:54:04",
"date_created_gmt": "2019-11-06T07:54:04",
"date_modified": "2019-11-06T09:54:04",
"date_modified_gmt": "2019-11-06T07:54:04",
"src": "https://example.com/wp-content/uploads/2019/11/T_2_back-8.jpg",
"name": "T_2_back-8.jpg",
"alt": ""
}
],
"attributes": [],
"default_attributes": [],
"variations": [],
"grouped_products": [],
"menu_order": 0,
"meta_data": [],
"bundle_layout": "",
"bundled_by": [],
"bundled_items": [],
"purchase_price": 15.2,
"supplier_id": 399,
"supplier_sku": "TEST1",
"barcode": "AAAAAABBBBBB",
"atum_controlled": true,
"out_stock_date": null,
"out_stock_threshold": 0,
"inheritable": false,
"inbound_stock": null,
"stock_on_hold": null,
"sold_today": null,
"sales_last_days": null,
"reserved_stock": null,
"customer_returns": null,
"warehouse_damage": null,
"lost_in_post": null,
"other_logs": null,
"out_stock_days": null,
"lost_sales": null,
"has_location": null,
"update_date": "2019-11-06T06:54:12",
"atum_locations": [
{
"id": 39,
"name": "Italy",
"slug": "italy"
},
{
"id": 37,
"name": "Spain",
"slug": "spain"
}
],
"linked_bom": [
{
"bom_id": 175,
"bom_type": "product_part",
"qty": 3
}
],
"sync_purchase_price": false,
"multi_inventory": "global",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/1998"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products"
}
]
}
}
Example of how to create a
variable product partproduct with global and non-global attributes:
curl -X POST https://example.com/wp-json/wc/v3/products \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"name": "ATUM BOM Test",
"type": "variable-product-part",
"description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
"short_description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.",
"categories": [
{
"id": 9
},
{
"id": 14
}
],
"images": [
{
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_4_front.jpg"
},
{
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_4_back.jpg"
},
{
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_3_front.jpg"
},
{
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_3_back.jpg"
}
],
"attributes": [
{
"id": 6,
"position": 0,
"visible": false,
"variation": true,
"options": [
"Black",
"Green"
]
},
{
"name": "Size",
"position": 0,
"visible": true,
"variation": true,
"options": [
"S",
"M"
]
}
],
"default_attributes": [
{
"id": 6,
"option": "Black"
},
{
"name": "Size",
"option": "S"
}
]
}'
const data = {
name: "ATUM BOM Test",
type: "variable-product-part",
description: "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
short_description: "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.",
categories: [
{
id: 9
},
{
id: 14
}
],
images: [
{
src: "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_4_front.jpg"
},
{
src: "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_4_back.jpg"
},
{
src: "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_3_front.jpg"
},
{
src: "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_3_back.jpg"
}
],
attributes: [
{
id: 6,
position: 0,
visible: true,
variation: true,
options: [
"Black",
"Green"
]
},
{
name: "Size",
position: 0,
visible: false,
variation: true,
options: [
"S",
"M"
]
}
],
default_attributes: [
{
id: 6,
option: "Black"
},
{
name: "Size",
option: "S"
}
]
};
WooCommerce.post("products", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'name' => 'ATUM BOM Test',
'type' => 'variable-product-part',
'description' => 'Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.',
'short_description' => 'Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.',
'categories' => [
[
'id' => 9
],
[
'id' => 14
]
],
'images' => [
[
'src' => 'http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_4_front.jpg'
],
[
'src' => 'http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_4_back.jpg'
],
[
'src' => 'http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_3_front.jpg'
],
[
'src' => 'http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_3_back.jpg'
]
],
'attributes' => [
[
'id' => 6,
'position' => 0,
'visible' => false,
'variation' => true,
'options' => [
'Black',
'Green'
]
],
[
'name' => 'Size',
'position' => 0,
'visible' => true,
'variation' => true,
'options' => [
'S',
'M'
]
]
],
'default_attributes' => [
[
'id' => 6,
'option' => 'Black'
],
[
'name' => 'Size',
'option' => 'S'
]
]
];
print_r($woocommerce->post('products', $data));
?>
data = {
"name": "ATUM BOM Test",
"type": "variable-product-part",
"description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
"short_description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.",
"categories": [
{
"id": 9
},
{
"id": 14
}
],
"images": [
{
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_4_front.jpg"
},
{
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_4_back.jpg"
},
{
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_3_front.jpg"
},
{
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_3_back.jpg"
}
],
"attributes": [
{
"id": 6,
"position": 0,
"visible": False,
"variation": True,
"options": [
"Black",
"Green"
]
},
{
"name": "Size",
"position": 0,
"visible": True,
"variation": True,
"options": [
"S",
"M"
]
}
],
"default_attributes": [
{
"id": 6,
"option": "Black"
},
{
"name": "Size",
"option": "S"
}
]
}
print(wcapi.post("products", data).json())
data = {
name: "ATUM BOM Test",
type: "variable-product-part",
description: "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
short_description: "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.",
categories: [
{
id: 9
},
{
id: 14
}
],
images: [
{
src: "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_4_front.jpg"
},
{
src: "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_4_back.jpg"
},
{
src: "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_3_front.jpg"
},
{
src: "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_3_back.jpg"
}
],
attributes: [
{
id: 6,
position: 0,
visible: false,
variation: true,
options: [
"Black",
"Green"
]
},
{
name: "Size",
position: 0,
visible: true,
variation: true,
options: [
"S",
"M"
]
}
],
default_attributes: [
{
id: 6,
option: "Black"
},
{
name: "Size",
option: "S"
}
]
}
woocommerce.post("products", data).parsed_response
JSON response example:
{
"id": 2101,
"name": "ATUM BOM Test",
"slug": "atum-bom-test-2",
"permalink": "https://example.com/product/atum-bom-test/",
"date_created": "2019-11-06T12:44:23",
"date_created_gmt": "2019-11-06T11:44:23",
"date_modified": "2019-11-06T12:44:23",
"date_modified_gmt": "2019-11-06T11:44:23",
"type": "variable-product-part",
"status": "publish",
"featured": false,
"catalog_visibility": "visible",
"description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
"short_description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.",
"sku": "",
"price": "",
"regular_price": "",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"price_html": "",
"on_sale": false,
"purchasable": false,
"total_sales": 0,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"external_url": "",
"button_text": "",
"tax_status": "taxable",
"tax_class": "",
"manage_stock": false,
"stock_quantity": null,
"stock_status": "outofstock",
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"sold_individually": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_required": false,
"shipping_taxable": false,
"shipping_class": "",
"shipping_class_id": 0,
"reviews_allowed": true,
"average_rating": "0",
"rating_count": 0,
"related_ids": [
31,
103,
19,
47,
2096
],
"upsell_ids": [],
"cross_sell_ids": [],
"parent_id": 0,
"purchase_note": "",
"categories": [
{
"id": 9,
"name": "Clothing",
"slug": "clothing"
},
{
"id": 14,
"name": "T-shirts",
"slug": "t-shirts"
}
],
"tags": [],
"images": [
{
"id": 2097,
"date_created": "2019-11-06T13:44:21",
"date_created_gmt": "2019-11-06T11:44:21",
"date_modified": "2019-11-06T13:44:21",
"date_modified_gmt": "2019-11-06T11:44:21",
"src": "https://example.com/wp-content/uploads/2019/11/T_4_front-20.jpg",
"name": "T_4_front-20.jpg",
"alt": ""
},
{
"id": 2098,
"date_created": "2019-11-06T13:44:21",
"date_created_gmt": "2019-11-06T11:44:21",
"date_modified": "2019-11-06T13:44:21",
"date_modified_gmt": "2019-11-06T11:44:21",
"src": "https://example.com/wp-content/uploads/2019/11/T_4_back-20.jpg",
"name": "T_4_back-20.jpg",
"alt": ""
},
{
"id": 2099,
"date_created": "2019-11-06T13:44:22",
"date_created_gmt": "2019-11-06T11:44:22",
"date_modified": "2019-11-06T13:44:22",
"date_modified_gmt": "2019-11-06T11:44:22",
"src": "https://example.com/wp-content/uploads/2019/11/T_3_front-20.jpg",
"name": "T_3_front-20.jpg",
"alt": ""
},
{
"id": 2100,
"date_created": "2019-11-06T13:44:22",
"date_created_gmt": "2019-11-06T11:44:22",
"date_modified": "2019-11-06T13:44:22",
"date_modified_gmt": "2019-11-06T11:44:22",
"src": "https://example.com/wp-content/uploads/2019/11/T_3_back-20.jpg",
"name": "T_3_back-20.jpg",
"alt": ""
}
],
"attributes": [
{
"id": 0,
"name": "Size",
"position": 0,
"visible": true,
"variation": true,
"options": [
"S",
"M"
]
}
],
"default_attributes": [
{
"id": 0,
"name": "",
"option": "black"
},
{
"id": 0,
"name": "Size",
"option": "S"
}
],
"variations": [],
"grouped_products": [],
"menu_order": 0,
"meta_data": [],
"bundle_layout": "",
"bundled_by": [],
"bundled_items": [],
"purchase_price": 0,
"supplier_id": 0,
"supplier_sku": "",
"barcode": "",
"atum_controlled": false,
"out_stock_date": null,
"out_stock_threshold": 0,
"inheritable": false,
"inbound_stock": null,
"stock_on_hold": null,
"sold_today": null,
"sales_last_days": null,
"reserved_stock": null,
"customer_returns": null,
"warehouse_damage": null,
"lost_in_post": null,
"other_logs": null,
"out_stock_days": null,
"lost_sales": null,
"has_location": null,
"update_date": "2019-11-06T10:44:23",
"atum_locations": [],
"linked_bom": [],
"sync_purchase_price": false,
"bom_sellable": false,
"minimum_threshold": null,
"available_to_purchase": null,
"selling_priority": null,
"calculated_stock": null,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/2101"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products"
}
]
}
}
Retrieve a product
This API lets you retrieve and view a specific product by ID.
HTTP request
GET
/wp-json/wc/v3/products/<id>
curl https://example.com/wp-json/wc/v3/products/70 \
-u consumer_key:consumer_secret
WooCommerce.get("products/70")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('products/70')); ?>
print(wcapi.get("products/70").json())
woocommerce.get("products/70").parsed_response
JSON response example:
{
"id": 70,
"name": "Flying Ninja",
"slug": "flying-ninja",
"permalink": "https://example.com/product/flying-ninja/",
"date_created": "2013-06-07T13:25:01",
"date_created_gmt": "2013-06-07T11:25:01",
"date_modified": "2019-10-25T11:57:08",
"date_modified_gmt": "2019-10-25T09:57:08",
"type": "simple",
"status": "publish",
"featured": false,
"catalog_visibility": "visible",
"description": "<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.</p>\n",
"short_description": "<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.</p>\n",
"sku": "",
"price": "50",
"regular_price": "50",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"price_html": "",
"on_sale": false,
"purchasable": false,
"total_sales": 54,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"external_url": "",
"button_text": "",
"tax_status": "taxable",
"tax_class": "",
"manage_stock": true,
"stock_quantity": 229,
"stock_status": "instock",
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"sold_individually": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_required": true,
"shipping_taxable": true,
"shipping_class": "",
"shipping_class_id": 0,
"reviews_allowed": true,
"average_rating": "4.00",
"rating_count": 4,
"related_ids": [
76,
73,
175,
79,
507
],
"upsell_ids": [],
"cross_sell_ids": [],
"parent_id": 0,
"purchase_note": "",
"categories": [
{
"id": 12,
"name": "Posters",
"slug": "posters"
}
],
"tags": [],
"images": [
{
"id": 71,
"date_created": "2013-06-07T13:24:19",
"date_created_gmt": "2013-06-07T11:24:19",
"date_modified": "2013-06-07T13:24:19",
"date_modified_gmt": "2013-06-07T11:24:19",
"src": "https://example.com/wp-content/uploads/2013/06/poster_2_up.jpg",
"name": "poster_2_up",
"alt": ""
},
{
"id": 72,
"date_created": "2013-06-07T13:24:47",
"date_created_gmt": "2013-06-07T11:24:47",
"date_modified": "2013-06-07T13:24:47",
"date_modified_gmt": "2013-06-07T11:24:47",
"src": "https://example.com/wp-content/uploads/2013/06/Poster_2_flat.jpg",
"name": "Poster_2_flat",
"alt": ""
}
],
"attributes": [],
"default_attributes": [],
"variations": [],
"grouped_products": [],
"menu_order": 0,
"meta_data": [],
"bundle_layout": "",
"bundled_by": [],
"bundled_items": [],
"purchase_price": 9,
"supplier_id": 399,
"supplier_sku": "",
"barcode": "",
"atum_controlled": true,
"out_stock_date": null,
"out_stock_threshold": 0,
"inheritable": false,
"inbound_stock": 1,
"stock_on_hold": 48,
"sold_today": 0,
"sales_last_days": 0,
"reserved_stock": 0,
"customer_returns": 0,
"warehouse_damage": 0,
"lost_in_post": 0,
"other_logs": 0,
"out_stock_days": 0,
"lost_sales": 0,
"has_location": true,
"update_date": "2019-10-25T06:25:24",
"atum_locations": [
{
"id": 39,
"name": "Italy",
"slug": "italy"
},
{
"id": 50,
"name": "Madrid",
"slug": "madrid"
},
{
"id": 37,
"name": "Spain",
"slug": "spain"
},
{
"id": 38,
"name": "United Kingdom",
"slug": "united-kingdom"
},
{
"id": 49,
"name": "Valencia",
"slug": "valencia"
}
],
"linked_bom": [
{
"bom_id": 183,
"bom_type": "raw_material",
"qty": 2
}
],
"sync_purchase_price": false,
"calculated_stock": 229,
"multi_inventory": "global",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/70"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products"
}
]
}
}
List all products
This API helps you to view all the products.
HTTP request
GET
/wp-json/wc/v3/products
curl https://example.com/wp-json/wc/v3/products \
-u consumer_key:consumer_secret
WooCommerce.get("products")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('products')); ?>
print(wcapi.get("products").json())
woocommerce.get("products").parsed_response
JSON response example:
[
{
"id": 507,
"name": "ABC 123 XPTO",
"slug": "abc-123-xpto",
"permalink": "https://example.com/product/abc-123-xpto/",
"date_created": "2018-12-28T08:21:22",
"date_created_gmt": "2018-12-28T07:21:22",
"date_modified": "2019-10-22T13:34:08",
"date_modified_gmt": "2019-10-22T11:34:08",
"type": "simple",
"status": "publish",
"featured": false,
"catalog_visibility": "visible",
"description": "",
"short_description": "",
"sku": "",
"price": null,
"regular_price": null,
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"price_html": "<span class=\"woocommerce-Price-amount amount\"><span class=\"woocommerce-Price-currencySymbol\">€</span>5,32</span> – <span class=\"woocommerce-Price-amount amount\"><span class=\"woocommerce-Price-currencySymbol\">€</span>20,00</span>",
"on_sale": false,
"purchasable": true,
"total_sales": 58,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"external_url": "",
"button_text": "",
"tax_status": "taxable",
"tax_class": "",
"manage_stock": true,
"stock_quantity": 0,
"stock_status": "outofstock",
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"sold_individually": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_required": true,
"shipping_taxable": true,
"shipping_class": "",
"shipping_class_id": 0,
"reviews_allowed": true,
"average_rating": "0.00",
"rating_count": 0,
"related_ids": [
70,
76,
79,
175,
67
],
"upsell_ids": [],
"cross_sell_ids": [],
"parent_id": 0,
"purchase_note": "",
"categories": [
{
"id": 12,
"name": "Posters",
"slug": "posters"
}
],
"tags": [],
"images": [],
"attributes": [],
"default_attributes": [],
"variations": [],
"grouped_products": [],
"menu_order": 0,
"meta_data": [],
"bundle_layout": "",
"bundled_by": [],
"bundled_items": [],
"purchase_price": 2,
"supplier_id": 399,
"supplier_sku": "CRYPTO",
"barcode": "BBBBBAAAAA",
"atum_controlled": true,
"out_stock_date": "2019-09-26T07:06:23",
"out_stock_threshold": 0,
"inheritable": false,
"inbound_stock": 6,
"stock_on_hold": 39,
"sold_today": 0,
"sales_last_days": 2,
"reserved_stock": 2,
"customer_returns": 0,
"warehouse_damage": 0,
"lost_in_post": 3,
"other_logs": 1,
"out_stock_days": 34,
"lost_sales": 0,
"has_location": false,
"update_date": null,
"atum_locations": [],
"linked_bom": [],
"sync_purchase_price": false,
"mi_inventories": [
152,
55,
126
],
"multi_inventory": "yes",
"inventory_sorting_mode": "global",
"inventory_iteration": "global",
"expirable_inventories": "global",
"price_per_inventory": "global",
"selectable_inventories": "global",
"selectable_inventories_mode": "global",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/507"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products"
}
]
}
},
{
"id": 90,
"name": "Woo Album #3",
"slug": "woo-album-3",
"permalink": "https://example.com/product/woo-album-3/",
"date_created": "2013-06-07T13:35:18",
"date_created_gmt": "2013-06-07T11:35:18",
"date_modified": "2019-10-30T11:50:51",
"date_modified_gmt": "2019-10-30T10:50:51",
"type": "simple",
"status": "publish",
"featured": false,
"catalog_visibility": "visible",
"description": "<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.</p>\n<p> </p>\n<div class=\"atum-mi-no-info\">This product has no inventory info available.</div>\n",
"short_description": "<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.</p>\n",
"sku": "WOO3",
"price": null,
"regular_price": null,
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"price_html": "<span class=\"woocommerce-Price-amount amount\"><span class=\"woocommerce-Price-currencySymbol\">€</span>10,00</span> – <span class=\"woocommerce-Price-amount amount\"><span class=\"woocommerce-Price-currencySymbol\">€</span>15,70</span>",
"on_sale": false,
"purchasable": true,
"total_sales": 137,
"virtual": false,
"downloadable": true,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"external_url": "",
"button_text": "",
"tax_status": "taxable",
"tax_class": "",
"manage_stock": true,
"stock_quantity": 0,
"stock_status": "outofstock",
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"sold_individually": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_required": true,
"shipping_taxable": true,
"shipping_class": "",
"shipping_class_id": 0,
"reviews_allowed": false,
"average_rating": "3.00",
"rating_count": 1,
"related_ids": [
99,
96,
669,
83,
649
],
"upsell_ids": [],
"cross_sell_ids": [],
"parent_id": 0,
"purchase_note": "",
"categories": [
{
"id": 15,
"name": "Albums",
"slug": "albums"
},
{
"id": 11,
"name": "Music",
"slug": "music"
}
],
"tags": [],
"images": [
{
"id": 91,
"date_created": "2013-06-07T13:34:58",
"date_created_gmt": "2013-06-07T11:34:58",
"date_modified": "2013-06-07T13:34:58",
"date_modified_gmt": "2013-06-07T11:34:58",
"src": "https://example.com/wp-content/uploads/2013/06/cd_3_angle.jpg",
"name": "cd_3_angle",
"alt": ""
},
{
"id": 92,
"date_created": "2013-06-07T13:35:10",
"date_created_gmt": "2013-06-07T11:35:10",
"date_modified": "2013-06-07T13:35:10",
"date_modified_gmt": "2013-06-07T11:35:10",
"src": "https://example.com/wp-content/uploads/2013/06/cd_3_flat.jpg",
"name": "cd_3_flat",
"alt": ""
}
],
"attributes": [],
"default_attributes": [],
"variations": [],
"grouped_products": [],
"menu_order": 0,
"meta_data": [
{
"id": 1390,
"key": "_download_type",
"value": ""
},
{
"id": 10290,
"key": "_bom_stock_control",
"value": "advanced"
}
],
"bundle_layout": "",
"bundled_by": [],
"bundled_items": [],
"purchase_price": 6,
"supplier_id": 399,
"supplier_sku": "SUPSK1",
"barcode": "XXXXXVVVVV",
"atum_controlled": true,
"out_stock_date": "2019-10-25T10:32:12",
"out_stock_threshold": 0,
"inheritable": false,
"inbound_stock": 5,
"stock_on_hold": 39,
"sold_today": 0,
"sales_last_days": 0,
"reserved_stock": 0,
"customer_returns": 0,
"warehouse_damage": 0,
"lost_in_post": 0,
"other_logs": 1,
"out_stock_days": 4,
"lost_sales": 0,
"has_location": true,
"update_date": null,
"atum_locations": [
{
"id": 39,
"name": "Italy",
"slug": "italy"
}
],
"linked_bom": [
{
"bom_id": 175,
"bom_type": "product_part",
"qty": 3
},
{
"bom_id": 182,
"bom_type": "raw_material",
"qty": 9
},
{
"bom_id": 184,
"bom_type": "product_part",
"qty": 35
}
],
"sync_purchase_price": true,
"calculated_stock": 0,
"mi_inventories": [
1,
2,
5,
85,
3
],
"multi_inventory": "yes",
"inventory_sorting_mode": "global",
"inventory_iteration": "global",
"expirable_inventories": "global",
"price_per_inventory": "global",
"selectable_inventories": "global",
"selectable_inventories_mode": "global",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/90"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products"
}
]
}
}
]
Available parameters
| Parameter | Type | Description |
|---|---|---|
context |
string | Scope under which the request is made; determines fields present in response. Options: view and edit. Default is view. |
page |
integer | Current page of the collection. Default is 1. |
per_page |
integer | Maximum number of items to be returned in result set. Default is 10. |
search |
string | Limit results to those matching a string. |
after |
string | Limit response to resources published after a given ISO8601 compliant date. |
before |
string | Limit response to resources published before a given ISO8601 compliant date. |
modified_after |
string | Limit response to resources modified after a given ISO8601 compliant date. |
modified_before |
string | Limit response to resources modified before a given ISO8601 compliant date. |
exclude |
array | Ensure result set excludes specific IDs. |
include |
array | Limit result set to specific ids. |
offset |
integer | Offset the result set by a specific number of items. |
order |
string | Order sort attribute ascending or descending. Options: asc and desc. Default is desc. |
orderby |
string | Sort collection by object attribute. Options: date, id, include, title and slug. Default is date. |
parent |
array | Limit result set to those of particular parent IDs. |
parent_exclude |
array | Limit result set to all items except those of a particular parent ID. |
slug |
string | Limit result set to products with a specific slug. |
status |
string | Limit result set to products assigned a specific status. Options: any, draft, pending, private and publish. Default is any. |
type |
string | Limit result set to products assigned a specific type. Options: simple, grouped, external, variable, product-part, raw-material, variable-product-part and variable-raw-material. |
sku |
string | Limit result set to products with a specific SKU. |
featured |
boolean | Limit result set to featured products. |
category |
string | Limit result set to products assigned a specific category ID. |
tag |
string | Limit result set to products assigned a specific tag ID. |
shipping_class |
string | Limit result set to products assigned a specific shipping class ID. |
attribute |
string | Limit result set to products with a specific attribute. |
attribute_term |
string | Limit result set to products with a specific attribute term ID (required an assigned attribute). |
tax_class |
string | Limit result set to products with a specific tax class. Default options: standard, reduced-rate and zero-rate. |
on_sale |
boolean | Limit result set to products on sale. |
min_price |
string | Limit result set to products based on a minimum price. |
max_price |
string | Limit result set to products based on a maximum price. |
stock_status |
string | Limit result set to products with specified stock status. Options: instock, outofstock and onbackorder. |
atum_location |
string | Limit result set to products assigned a specific ATUM Location ID. ATUM |
atum_controlled |
boolean | Limit result set to products controlled by ATUM. ATUM |
atum_min_purchase_price |
number | Limit result set to products based on a minimum purchase price. ATUM |
atum_max_purchase_price |
number | Limit result set to products based on a maximum purchase price. ATUM |
atum_supplier |
integer | Limit result set to products linked to the specified Supplier ID. ATUM |
atum_supplier_sku |
string | Limit result set to products with a specific Supplier SKU. ATUM |
atum_barcode |
string | Limit result set to products with a specific barcode. ATUM |
atum_multi_inventory |
string | Limit result set to products with a specific Multi-Inventory status. Options: yes, no and global. Multi-Inventory ATUM |
atum_inventory_sorting_mode |
string | Limit result set to products with a specific inventory sorting mode. Options: fifo, lifo, bbe, manual and global. Multi-Inventory ATUM |
atum_inventory_iteration |
string | Limit result set to products with a specific inventory iteration. Options: use_next, out_of_stock and global. Multi-Inventory ATUM |
atum_expirable_inventories |
string | Limit result set to products with a specific expirable inventories option. Options: yes, no and global. Multi-Inventory ATUM |
atum_price_per_inventory |
string | Limit result set to products with a specific price per inventory option. Options: yes, no and global. Multi-Inventory ATUM |
atum_selectable_inventories |
string | Limit result set to products with a specific selectable inventories option. Options: yes, no and global. Multi-Inventory ATUM |
atum_selectable_inventories_mode |
string | Limit result set to products with a specific selectable inventories mode option. Options: dropdown, list and global. Multi-Inventory ATUM |
atum_bom_sellable |
boolean | Limit result set to sellable BOM products. It should be used in conjunction with the type set to any BOM type. Product Levels ATUM |
Update a product
This API lets you make changes to a product.
HTTP request
PUT
/wp-json/wc/v3/products/<id>
curl -X PUT https://example.com/wp-json/wc/v3/products/70 \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"purchase_price": 24.54
}'
const data = {
purchase_price: 24.54
};
WooCommerce.put("products/70", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'purchase_price' => 24.54
];
print_r($woocommerce->put('products/70', $data));
?>
data = {
"purchase_price": 24.54
}
print(wcapi.put("products/70", data).json())
data = {
purchase_price: 24.54
}
woocommerce.put("products/70", data).parsed_response
JSON response example:
{
"id": 70,
"name": "Flying Ninja",
"slug": "flying-ninja",
"permalink": "https://example.com/product/flying-ninja/",
"date_created": "2013-06-07T13:25:01",
"date_created_gmt": "2013-06-07T11:25:01",
"date_modified": "2019-11-07T12:54:35",
"date_modified_gmt": "2019-11-07T11:54:35",
"type": "simple",
"status": "publish",
"featured": false,
"catalog_visibility": "visible",
"description": "<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.</p>\n",
"short_description": "<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.</p>\n",
"sku": "",
"price": "50",
"regular_price": "50",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"price_html": "<span class=\"woocommerce-Price-amount amount\"><span class=\"woocommerce-Price-currencySymbol\">€</span>50,00</span>",
"on_sale": false,
"purchasable": true,
"total_sales": 54,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"external_url": "",
"button_text": "",
"tax_status": "taxable",
"tax_class": "",
"manage_stock": true,
"stock_quantity": 229,
"stock_status": "instock",
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"sold_individually": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_required": true,
"shipping_taxable": true,
"shipping_class": "",
"shipping_class_id": 0,
"reviews_allowed": true,
"average_rating": "4.00",
"rating_count": 4,
"related_ids": [
507,
76,
73,
175,
67
],
"upsell_ids": [],
"cross_sell_ids": [],
"parent_id": 0,
"purchase_note": "",
"categories": [
{
"id": 12,
"name": "Posters",
"slug": "posters"
}
],
"tags": [],
"images": [
{
"id": 71,
"date_created": "2013-06-07T13:24:19",
"date_created_gmt": "2013-06-07T11:24:19",
"date_modified": "2013-06-07T13:24:19",
"date_modified_gmt": "2013-06-07T11:24:19",
"src": "https://example.com/wp-content/uploads/2013/06/poster_2_up.jpg",
"name": "poster_2_up",
"alt": ""
},
{
"id": 72,
"date_created": "2013-06-07T13:24:47",
"date_created_gmt": "2013-06-07T11:24:47",
"date_modified": "2013-06-07T13:24:47",
"date_modified_gmt": "2013-06-07T11:24:47",
"src": "https://example.com/wp-content/uploads/2013/06/Poster_2_flat.jpg",
"name": "Poster_2_flat",
"alt": ""
}
],
"attributes": [],
"default_attributes": [],
"variations": [],
"grouped_products": [],
"menu_order": 0,
"meta_data": [],
"bundle_layout": "",
"bundled_by": [],
"bundled_items": [],
"purchase_price": 24.54,
"supplier_id": 399,
"supplier_sku": "",
"barcode": "",
"atum_controlled": true,
"out_stock_date": null,
"out_stock_threshold": 0,
"inheritable": false,
"inbound_stock": 1,
"stock_on_hold": 48,
"sold_today": 0,
"sales_last_days": 0,
"reserved_stock": 0,
"customer_returns": 0,
"warehouse_damage": 0,
"lost_in_post": 0,
"other_logs": 0,
"out_stock_days": 0,
"lost_sales": 0,
"has_location": true,
"update_date": "2019-11-07T10:54:37",
"atum_locations": [
{
"id": 39,
"name": "Italy",
"slug": "italy"
},
{
"id": 50,
"name": "Madrid",
"slug": "madrid"
},
{
"id": 37,
"name": "Spain",
"slug": "spain"
},
{
"id": 38,
"name": "United Kingdom",
"slug": "united-kingdom"
},
{
"id": 49,
"name": "Valencia",
"slug": "valencia"
}
],
"linked_bom": [
{
"bom_id": 183,
"bom_type": "raw_material",
"qty": 2
}
],
"sync_purchase_price": false,
"calculated_stock": 229,
"mi_inventories": [
62
],
"multi_inventory": "global",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/70"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products"
}
]
}
}
Delete a product
This API helps you delete a product.
HTTP request
DELETE
/wp-json/wc/v3/products/<id>
curl -X DELETE https://example.com/wp-json/wc/v3/products/1998?force=true \
-u consumer_key:consumer_secret
WooCommerce.delete("products/1998", {
force: true
})
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->delete('products/1998', ['force' => true])); ?>
print(wcapi.delete("products/1998", params={"force": True}).json())
woocommerce.delete("products/1998", force: true).parsed_response
JSON response example:
{
"id": 1998,
"name": "ATUM Test Product",
"slug": "atum-test-product",
"permalink": "https://example.com/product/atum-test-product/",
"date_created": "2019-11-06T08:54:04",
"date_created_gmt": "2019-11-06T07:54:04",
"date_modified": "2019-11-07T13:00:07",
"date_modified_gmt": "2019-11-07T12:00:07",
"type": "simple",
"status": "publish",
"featured": false,
"catalog_visibility": "visible",
"description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
"short_description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.",
"sku": "",
"price": "21.99",
"regular_price": "21.99",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"price_html": "<span class=\"woocommerce-Price-amount amount\"><span class=\"woocommerce-Price-currencySymbol\">€</span>21,99</span>",
"on_sale": false,
"purchasable": true,
"total_sales": 0,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"external_url": "",
"button_text": "",
"tax_status": "taxable",
"tax_class": "",
"manage_stock": false,
"stock_quantity": null,
"stock_status": "instock",
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"sold_individually": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_required": true,
"shipping_taxable": true,
"shipping_class": "",
"shipping_class_id": 0,
"reviews_allowed": true,
"average_rating": "0",
"rating_count": 0,
"related_ids": [
34,
50,
37,
115,
103
],
"upsell_ids": [],
"cross_sell_ids": [],
"parent_id": 0,
"purchase_note": "",
"categories": [
{
"id": 9,
"name": "Clothing",
"slug": "clothing"
},
{
"id": 14,
"name": "T-shirts",
"slug": "t-shirts"
}
],
"tags": [],
"images": [
{
"id": 1996,
"date_created": "2019-11-06T09:54:03",
"date_created_gmt": "2019-11-06T07:54:03",
"date_modified": "2019-11-06T09:54:03",
"date_modified_gmt": "2019-11-06T07:54:03",
"src": "https://example.com/wp-content/uploads/2019/11/T_2_front-8.jpg",
"name": "T_2_front-8.jpg",
"alt": ""
},
{
"id": 1997,
"date_created": "2019-11-06T09:54:04",
"date_created_gmt": "2019-11-06T07:54:04",
"date_modified": "2019-11-06T09:54:04",
"date_modified_gmt": "2019-11-06T07:54:04",
"src": "https://example.com/wp-content/uploads/2019/11/T_2_back-8.jpg",
"name": "T_2_back-8.jpg",
"alt": ""
}
],
"attributes": [],
"default_attributes": [],
"variations": [],
"grouped_products": [],
"menu_order": 0,
"meta_data": [],
"bundle_layout": "",
"bundled_by": [],
"bundled_items": [],
"purchase_price": 15.2,
"supplier_id": 399,
"supplier_sku": "TEST1",
"barcode": "AAAAAABBBBBB",
"atum_controlled": true,
"out_stock_date": null,
"out_stock_threshold": 0,
"inheritable": false,
"inbound_stock": 0,
"stock_on_hold": 0,
"sold_today": 0,
"sales_last_days": 0,
"reserved_stock": 0,
"customer_returns": 0,
"warehouse_damage": 0,
"lost_in_post": 0,
"other_logs": 0,
"out_stock_days": 0,
"lost_sales": 0,
"has_location": true,
"update_date": "2019-11-07T07:40:51",
"atum_locations": [
{
"id": 39,
"name": "Italy",
"slug": "italy"
},
{
"id": 37,
"name": "Spain",
"slug": "spain"
}
],
"linked_bom": [
{
"bom_id": 175,
"bom_type": "product_part",
"qty": 3
}
],
"sync_purchase_price": false,
"calculated_stock": 117,
"mi_inventories": [
174
],
"multi_inventory": "global",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/1998"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products"
}
]
}
}
Available parameters
| Parameter | Type | Description |
|---|---|---|
force |
string | Use true whether to permanently delete the product, Default is false. |
Batch update products
This API helps you to batch create, update and delete multiple products.
HTTP request
POST
/wp-json/wc/v3/products/batch
curl -X POST https://example.com/wp-json/wc/v3/products/batch \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"create": [
{
"name": "TEST Batch Product",
"type": "simple",
"regular_price": "21.99",
"virtual": true,
"downloadable": true,
"downloads": [
{
"name": "Woo Single",
"file": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/cd_4_angle.jpg"
}
],
"categories": [
{
"id": 11
},
{
"id": 13
}
],
"images": [
{
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/cd_4_angle.jpg"
}
]
},
{
"name": "TEST Batch BOM Product",
"type": "raw-material",
"regular_price": "21.99",
"description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
"short_description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.",
"categories": [
{
"id": 9
},
{
"id": 14
}
],
"images": [
{
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_front.jpg"
},
{
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_back.jpg"
}
]
}
],
"update": [
{
"id": 507,
"linked_bom": [
{
"bom_id": 183,
"bom_type": "raw_material",
"qty": 2
},
{
"bom_id": 184,
"bom_type": "product_part",
"qty": 1
}
],
"multi_inventory": "no"
}
],
"delete": [
2121
]
}'
const data = {
create: [
{
name: "TEST Batch Product",
type: "simple",
regular_price: "21.99",
virtual: true,
downloadable: true,
downloads: [
{
name: "Woo Single",
file: "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/cd_4_angle.jpg"
}
],
categories: [
{
id: 11
},
{
id: 13
}
],
images: [
{
src: "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/cd_4_angle.jpg"
}
]
},
{
name: "TEST Batch BOM Product",
type: "raw-material",
regular_price: "21.99",
description: "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
short_description: "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.",
categories: [
{
id: 9
},
{
id: 14
}
],
images: [
{
src: "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_front.jpg"
},
{
src: "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_back.jpg"
}
]
}
],
update: [
{
id: 507,
linked_bom: [
{
bom_id: 183,
bom_type: "raw_material",
qty: 2
},
{
bom_id: 184,
bom_type: "product_part",
qty: 1
}
],
multi_inventory: "no"
}
],
delete: [
2121
]
};
WooCommerce.post("products/batch", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'create' => [
[
'name' => 'TEST Batch Product',
'type' => 'simple',
'regular_price' => '21.99',
'virtual' => true,
'downloadable' => true,
'downloads' => [
[
'name' => 'Woo Single',
'file' => 'http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/cd_4_angle.jpg'
]
],
'categories' => [
[
'id' => 11
],
[
'id' => 13
]
],
'images' => [
[
'src' => 'http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/cd_4_angle.jpg'
]
]
],
[
'name' => 'TEST Batch BOM Product',
'type' => 'raw-material',
'regular_price' => '21.99',
'description' => 'Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.',
'short_description' => 'Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.',
'categories' => [
[
'id' => 9
],
[
'id' => 14
]
],
'images' => [
[
'src' => 'http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_front.jpg'
],
[
'src' => 'http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_back.jpg'
]
]
]
],
'update' => [
[
'id' => 507,
'linked_bom' => [
[
'bom_id' => 183,
'bom_type' => 'raw_material',
'qty' => 2
],
[
'bom_id' => 184,
'bom_type' => 'product_part',
'qty' => 1
]
],
'multi_inventory' => 'no'
]
],
'delete' => [
2121
]
];
print_r($woocommerce->post('products/batch', $data));
?>
data = {
"create": [
{
"name": "TEST Batch Product",
"type": "simple",
"regular_price": "21.99",
"virtual": true,
"downloadable": true,
"downloads": [
{
"name": "Woo Single",
"file": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/cd_4_angle.jpg"
}
],
"categories": [
{
"id": 11
},
{
"id": 13
}
],
"images": [
{
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/cd_4_angle.jpg"
}
]
},
{
"name": "TEST Batch BOM Product",
"type": "raw-material",
"regular_price": "21.99",
"description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
"short_description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.",
"categories": [
{
"id": 9
},
{
"id": 14
}
],
"images": [
{
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_front.jpg"
},
{
"src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_back.jpg"
}
]
}
],
"update": [
{
"id": 507,
"linked_bom": [
{
"bom_id": 183,
"bom_type": "raw_material",
"qty": 2
},
{
"bom_id": 184,
"bom_type": "product_part",
"qty": 1
}
],
"multi_inventory": "no"
}
],
"delete": [
2121
]
}
print(wcapi.post("products/batch", data).json())
data = {
create: [
{
name: "TEST Batch Product",
type: "simple",
regular_price: "21.99",
virtual: true,
downloadable: true,
downloads: [
{
name: "Woo Single",
file: "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/cd_4_angle.jpg"
}
],
categories: [
{
id: 11
},
{
id: 13
}
],
images: [
{
src: "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/cd_4_angle.jpg"
}
]
},
{
name: "TEST Batch BOM Product",
type: "raw-material",
regular_price: "21.99",
description: "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
short_description: "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.",
categories: [
{
id: 9
},
{
id: 14
}
],
images: [
{
src: "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_front.jpg"
},
{
src: "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_back.jpg"
}
]
}
],
update: [
{
id: 507,
linked_bom: [
{
bom_id: 183,
bom_type: "raw_material",
qty: 2
},
{
bom_id: 184,
bom_type: "product_part",
qty: 1
}
],
multi_inventory: "no"
}
],
delete: [
2121
]
}
woocommerce.post("products/batch", data).parsed_response
JSON response example:
{
"create": [
{
"id": 2123,
"name": "TEST Batch Product",
"slug": "test-batch-product",
"permalink": "https://example.com/product/test-batch-product/",
"date_created": "2019-11-07T13:16:32",
"date_created_gmt": "2019-11-07T12:16:32",
"date_modified": "2019-11-07T13:16:32",
"date_modified_gmt": "2019-11-07T12:16:32",
"type": "simple",
"status": "publish",
"featured": false,
"catalog_visibility": "visible",
"description": "",
"short_description": "",
"sku": "",
"price": "21.99",
"regular_price": "21.99",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"price_html": "<span class=\"woocommerce-Price-amount amount\"><span class=\"woocommerce-Price-currencySymbol\">€</span>21,99</span>",
"on_sale": false,
"purchasable": true,
"total_sales": 0,
"virtual": true,
"downloadable": true,
"downloads": [
{
"id": "0e47b414-0469-4c6a-9ded-f2a8ea0b6ca4",
"name": "Woo Single",
"file": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/cd_4_angle.jpg"
}
],
"download_limit": -1,
"download_expiry": -1,
"external_url": "",
"button_text": "",
"tax_status": "taxable",
"tax_class": "",
"manage_stock": false,
"stock_quantity": null,
"stock_status": "instock",
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"sold_individually": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_required": false,
"shipping_taxable": false,
"shipping_class": "",
"shipping_class_id": 0,
"reviews_allowed": true,
"average_rating": "0",
"rating_count": 0,
"related_ids": [
649,
83,
90,
87,
96
],
"upsell_ids": [],
"cross_sell_ids": [],
"parent_id": 0,
"purchase_note": "",
"categories": [
{
"id": 11,
"name": "Music",
"slug": "music"
},
{
"id": 13,
"name": "Singles",
"slug": "singles"
}
],
"tags": [],
"images": [
{
"id": 2122,
"date_created": "2019-11-07T14:16:31",
"date_created_gmt": "2019-11-07T12:16:31",
"date_modified": "2019-11-07T14:16:31",
"date_modified_gmt": "2019-11-07T12:16:31",
"src": "https://example.com/wp-content/uploads/2019/11/cd_4_angle-1.jpg",
"name": "cd_4_angle-1.jpg",
"alt": ""
}
],
"attributes": [],
"default_attributes": [],
"variations": [],
"grouped_products": [],
"menu_order": 0,
"meta_data": [],
"bundle_layout": "",
"bundled_by": [],
"bundled_items": [],
"purchase_price": 0,
"supplier_id": 0,
"supplier_sku": "",
"barcode": "",
"atum_controlled": false,
"out_stock_date": null,
"out_stock_threshold": 0,
"inheritable": false,
"inbound_stock": null,
"stock_on_hold": null,
"sold_today": null,
"sales_last_days": null,
"reserved_stock": null,
"customer_returns": null,
"warehouse_damage": null,
"lost_in_post": null,
"other_logs": null,
"out_stock_days": null,
"lost_sales": null,
"has_location": null,
"update_date": "2019-11-07T11:16:32",
"atum_locations": [],
"linked_bom": [],
"sync_purchase_price": false,
"mi_inventories": [],
"multi_inventory": "global",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/2123"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products"
}
]
}
},
{
"id": 2126,
"name": "TEST Batch BOM Product",
"slug": "test-batch-bom-product",
"permalink": "https://example.com/product/test-batch-bom-product/",
"date_created": "2019-11-07T13:16:34",
"date_created_gmt": "2019-11-07T12:16:34",
"date_modified": "2019-11-07T13:16:34",
"date_modified_gmt": "2019-11-07T12:16:34",
"type": "raw-material",
"status": "publish",
"featured": false,
"catalog_visibility": "visible",
"description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
"short_description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.",
"sku": "",
"price": "21.99",
"regular_price": "21.99",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"price_html": "<span class=\"woocommerce-Price-amount amount\"><span class=\"woocommerce-Price-currencySymbol\">€</span>21,99</span>",
"on_sale": false,
"purchasable": false,
"total_sales": 0,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"external_url": "",
"button_text": "",
"tax_status": "taxable",
"tax_class": "",
"manage_stock": true,
"stock_quantity": null,
"stock_status": "outofstock",
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"sold_individually": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_required": false,
"shipping_taxable": false,
"shipping_class": "",
"shipping_class_id": 0,
"reviews_allowed": true,
"average_rating": "0",
"rating_count": 0,
"related_ids": [
31,
103,
19,
56,
115
],
"upsell_ids": [],
"cross_sell_ids": [],
"parent_id": 0,
"purchase_note": "",
"categories": [
{
"id": 9,
"name": "Clothing",
"slug": "clothing"
},
{
"id": 14,
"name": "T-shirts",
"slug": "t-shirts"
}
],
"tags": [],
"images": [
{
"id": 2124,
"date_created": "2019-11-07T14:16:33",
"date_created_gmt": "2019-11-07T12:16:33",
"date_modified": "2019-11-07T14:16:33",
"date_modified_gmt": "2019-11-07T12:16:33",
"src": "https://example.com/wp-content/uploads/2019/11/T_2_front-12.jpg",
"name": "T_2_front-12.jpg",
"alt": ""
},
{
"id": 2125,
"date_created": "2019-11-07T14:16:33",
"date_created_gmt": "2019-11-07T12:16:33",
"date_modified": "2019-11-07T14:16:33",
"date_modified_gmt": "2019-11-07T12:16:33",
"src": "https://example.com/wp-content/uploads/2019/11/T_2_back-12.jpg",
"name": "T_2_back-12.jpg",
"alt": ""
}
],
"attributes": [],
"default_attributes": [],
"variations": [],
"grouped_products": [],
"menu_order": 0,
"meta_data": [],
"bundle_layout": "",
"bundled_by": [],
"bundled_items": [],
"purchase_price": 0,
"supplier_id": 0,
"supplier_sku": "",
"barcode": "",
"atum_controlled": false,
"out_stock_date": null,
"out_stock_threshold": 0,
"inheritable": false,
"inbound_stock": null,
"stock_on_hold": null,
"sold_today": null,
"sales_last_days": null,
"reserved_stock": null,
"customer_returns": null,
"warehouse_damage": null,
"lost_in_post": null,
"other_logs": null,
"out_stock_days": null,
"lost_sales": null,
"has_location": null,
"update_date": "2019-11-07T11:16:34",
"atum_locations": [],
"linked_bom": [],
"sync_purchase_price": false,
"bom_sellable": null,
"minimum_threshold": null,
"available_to_purchase": null,
"selling_priority": null,
"calculated_stock": null,
"mi_inventories": [],
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/2126"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products"
}
]
}
}
],
"update": [
{
"id": 507,
"name": "ABC 123 XPTO",
"slug": "abc-123-xpto",
"permalink": "https://example.com/product/abc-123-xpto/",
"date_created": "2018-12-28T08:21:22",
"date_created_gmt": "2018-12-28T07:21:22",
"date_modified": "2019-11-07T13:16:35",
"date_modified_gmt": "2019-11-07T12:16:35",
"type": "simple",
"status": "publish",
"featured": false,
"catalog_visibility": "visible",
"description": "",
"short_description": "",
"sku": "",
"price": "5.32",
"regular_price": "5.32",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"price_html": "<span class=\"woocommerce-Price-amount amount\"><span class=\"woocommerce-Price-currencySymbol\">€</span>5,32</span> – <span class=\"woocommerce-Price-amount amount\"><span class=\"woocommerce-Price-currencySymbol\">€</span>20,00</span>",
"on_sale": false,
"purchasable": true,
"total_sales": 58,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"external_url": "",
"button_text": "",
"tax_status": "taxable",
"tax_class": "",
"manage_stock": true,
"stock_quantity": null,
"stock_status": "outofstock",
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"sold_individually": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_required": true,
"shipping_taxable": true,
"shipping_class": "",
"shipping_class_id": 0,
"reviews_allowed": true,
"average_rating": "0",
"rating_count": 0,
"related_ids": [
79,
70,
73,
175,
76
],
"upsell_ids": [],
"cross_sell_ids": [],
"parent_id": 0,
"purchase_note": "",
"categories": [
{
"id": 12,
"name": "Posters",
"slug": "posters"
}
],
"tags": [],
"images": [],
"attributes": [],
"default_attributes": [],
"variations": [],
"grouped_products": [],
"menu_order": 0,
"meta_data": [],
"bundle_layout": "",
"bundled_by": [],
"bundled_items": [],
"purchase_price": 2,
"supplier_id": 399,
"supplier_sku": "CRYPTO",
"barcode": "BBBBBAAAAA",
"atum_controlled": true,
"out_stock_date": "2019-09-26T07:06:23",
"out_stock_threshold": 0,
"inheritable": false,
"inbound_stock": 6,
"stock_on_hold": 39,
"sold_today": 0,
"sales_last_days": 2,
"reserved_stock": 2,
"customer_returns": 0,
"warehouse_damage": 0,
"lost_in_post": 3,
"other_logs": 1,
"out_stock_days": 34,
"lost_sales": 0,
"has_location": false,
"update_date": "2019-11-07T08:40:50",
"atum_locations": [],
"linked_bom": [
{
"bom_id": 183,
"bom_type": "raw_material",
"qty": 2
},
{
"bom_id": 184,
"bom_type": "product_part",
"qty": 1
}
],
"sync_purchase_price": false,
"mi_inventories": [
152,
55,
126
],
"multi_inventory": "no",
"inventory_sorting_mode": "global",
"inventory_iteration": "use_next",
"expirable_inventories": "no",
"price_per_inventory": "yes",
"selectable_inventories": "global",
"selectable_inventories_mode": "global",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/507"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products"
}
]
}
}
],
"delete": [
{
"id": 2121,
"name": "ATUM Test Product",
"slug": "atum-test-product",
"permalink": "https://example.com/product/atum-test-product/",
"date_created": "2019-11-07T13:11:59",
"date_created_gmt": "2019-11-07T12:11:59",
"date_modified": "2019-11-07T13:12:29",
"date_modified_gmt": "2019-11-07T12:12:29",
"type": "simple",
"status": "publish",
"featured": false,
"catalog_visibility": "visible",
"description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
"short_description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.",
"sku": "",
"price": "21.99",
"regular_price": "21.99",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"price_html": "<span class=\"woocommerce-Price-amount amount\"><span class=\"woocommerce-Price-currencySymbol\">€</span>21,99</span>",
"on_sale": false,
"purchasable": true,
"total_sales": 0,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"external_url": "",
"button_text": "",
"tax_status": "taxable",
"tax_class": "",
"manage_stock": false,
"stock_quantity": null,
"stock_status": "instock",
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"sold_individually": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_required": true,
"shipping_taxable": true,
"shipping_class": "",
"shipping_class_id": 0,
"reviews_allowed": true,
"average_rating": "0",
"rating_count": 0,
"related_ids": [
50,
15,
19,
31,
40
],
"upsell_ids": [],
"cross_sell_ids": [],
"parent_id": 0,
"purchase_note": "",
"categories": [
{
"id": 9,
"name": "Clothing",
"slug": "clothing"
},
{
"id": 14,
"name": "T-shirts",
"slug": "t-shirts"
}
],
"tags": [],
"images": [
{
"id": 2119,
"date_created": "2019-11-07T14:11:58",
"date_created_gmt": "2019-11-07T12:11:58",
"date_modified": "2019-11-07T14:11:58",
"date_modified_gmt": "2019-11-07T12:11:58",
"src": "https://example.com/wp-content/uploads/2019/11/T_2_front-11.jpg",
"name": "T_2_front-11.jpg",
"alt": ""
},
{
"id": 2120,
"date_created": "2019-11-07T14:11:58",
"date_created_gmt": "2019-11-07T12:11:58",
"date_modified": "2019-11-07T14:11:58",
"date_modified_gmt": "2019-11-07T12:11:58",
"src": "https://example.com/wp-content/uploads/2019/11/T_2_back-11.jpg",
"name": "T_2_back-11.jpg",
"alt": ""
}
],
"attributes": [],
"default_attributes": [],
"variations": [],
"grouped_products": [],
"menu_order": 0,
"meta_data": [],
"bundle_layout": "",
"bundled_by": [],
"bundled_items": [],
"purchase_price": 15.2,
"supplier_id": 399,
"supplier_sku": "TEST1",
"barcode": "AAAAAABBBBBB",
"atum_controlled": true,
"out_stock_date": null,
"out_stock_threshold": 0,
"inheritable": false,
"inbound_stock": null,
"stock_on_hold": null,
"sold_today": null,
"sales_last_days": null,
"reserved_stock": null,
"customer_returns": null,
"warehouse_damage": null,
"lost_in_post": null,
"other_logs": null,
"out_stock_days": null,
"lost_sales": null,
"has_location": null,
"update_date": "2019-11-07T11:12:29",
"atum_locations": [
{
"id": 39,
"name": "Italy",
"slug": "italy"
},
{
"id": 37,
"name": "Spain",
"slug": "spain"
}
],
"linked_bom": [
{
"bom_id": 175,
"bom_type": "product_part",
"qty": 3
}
],
"sync_purchase_price": false,
"calculated_stock": 117,
"mi_inventories": [
180
],
"multi_inventory": "global",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/2121"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products"
}
]
}
}
]
}
Product variations
This endpoint is an extension of the official WC's orders enndpoint with extra info added by ATUM and/or its add-ons. You can identify the ATUM data with the corresponding labels.
The product variations API allows you to create, view, update, and delete individual, or a batch, of product variations.
Product variation properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Unique identifier for the resource. read-only |
date_created |
date-time | The date the variation was created, in the site's timezone. read-only |
date_created_gmt |
date-time | The date the variation was created, as GMT. read-only |
date_modified |
date-time | The date the variation was last modified, in the site's timezone. read-only |
date_modified_gmt |
date-time | The date the variation was last modified, as GMT. read-only |
description |
string | Variation description. |
permalink |
string | Variation URL. read-only |
sku |
string | Unique identifier. |
price |
string | Current variation price. read-only |
regular_price |
string | Variation regular price. |
sale_price |
string | Variation sale price. |
date_on_sale_from |
date-time | Start date of sale price, in the site's timezone. |
date_on_sale_from_gmt |
date-time | Start date of sale price, as GMT. |
date_on_sale_to |
date-time | End date of sale price, in the site's timezone. |
date_on_sale_to_gmt |
date-time | End date of sale price, as GMT. |
on_sale |
boolean | Shows if the variation is on sale. read-only |
status |
string | Variation status. Options: draft, pending, private and publish. Default is publish. |
purchasable |
boolean | Shows if the variation can be bought. read-only |
virtual |
boolean | If the variation is virtual. Default is false. |
downloadable |
boolean | If the variation is downloadable. Default is false. |
downloads |
array | List of downloadable files. See Product variation - Downloads properties |
download_limit |
integer | Number of times downloadable files can be downloaded after purchase. Default is -1. |
download_expiry |
integer | Number of days until access to downloadable files expires. Default is -1. |
tax_status |
string | Tax status. Options: taxable, shipping and none. Default is taxable. |
tax_class |
string | Tax class. |
manage_stock |
boolean | Stock management at variation level. Default is false. |
stock_quantity |
integer | Stock quantity. |
stock_status |
string | Controls the stock status of the product. Options: instock, outofstock, onbackorder. Default is instock. |
backorders |
string | If managing stock, this controls if backorders are allowed. Options: no, notify and yes. Default is no. |
backorders_allowed |
boolean | Shows if backorders are allowed. read-only |
backordered |
boolean | Shows if the variation is on backordered. read-only |
weight |
string | Variation weight. |
dimensions |
object | Variation dimensions. See Product variation - Dimensions properties |
shipping_class |
string | Shipping class slug. |
shipping_class_id |
string | Shipping class ID. read-only |
image |
object | Variation image data. See Product variation - Image properties |
attributes |
array | List of attributes. See Product variation - Attributes properties |
menu_order |
integer | Menu order, used to custom sort products. |
meta_data |
array | Meta data. See Product variation - Meta data properties |
purchase_price |
number | Product's purchase price. ATUM |
supplier_id |
integer | The ID of the ATUM Supplier that is linked to this product. ATUM |
supplier_sku |
string | The Supplier's SKU for this product. ATUM |
barcode |
string | The barcode for this product. ATUM |
atum_controlled |
boolean | Whether this product is being controlled by ATUM. Default is false. ATUM |
out_stock_date |
date-time | The date when this product run out of stock. ATUM |
out_stock_threshold |
number | Out of stock threshold at product level. ATUM |
inbound_stock |
number | Product's inbound stock. ATUM |
stock_on_hold |
number | Product's stock on hold. ATUM |
sold_today |
number | Units sold today. ATUM |
sales_last_days |
number | Sales the last 14 days. ATUM |
reserved_stock |
number | Stock set as 'reserved_stock' within Inventory Logs. ATUM |
customer_returns |
number | Stock set as 'customer returns' within Inventory Logs. ATUM |
warehouse_damage |
number | Stock set as 'warehouse damage' within Inventory Logs. ATUM |
lost_in_post |
number | Stock set as 'lost in post' within Inventory Logs. ATUM |
other_logs |
number | Stock set as 'other' within Inventory Logs. ATUM |
out_stock_days |
integer | The number of days that the product is Out of stock. ATUM |
lost_sales |
number | Product lost sales. ATUM |
update_date |
date-time | Last date when the ATUM product data was calculated and saved for this product. ATUM |
mi_inventories |
array | An array of inventory IDs linked to the product (if any). Multi-Inventory ATUM read-only |
multi_inventory |
string | The Multi Inventory status for this product. Options: yes, no, global. Multi-Inventory ATUM |
inventory_sorting_mode |
string | The sorting mode specified for inventory selling priority. Options: fifo, lifo, bbe, manual, global. Multi-Inventory ATUM |
inventory_iteration |
string | What to do when the first selling inventory runs out of stock. Options: use_next, out_of_stock, global. Multi-Inventory ATUM |
expirable_inventories |
string | Set the inventories as 'Out of Stock' when reaching their BBE dates. Options: yes, no, global. Multi-Inventory ATUM |
price_per_inventory |
string | Allow distinct inventories to have distinct prices. Options: yes, no, global. Multi-Inventory ATUM |
linked_bom |
array | The BOM linked to the product with their quantities. See Product - Linked BOM properties Product Levels ATUM |
bom_sellable |
array | If the product is a BOM, indicates whether the product is sellable. Product Levels ATUM |
minimum_threshold |
number | If the product is a BOM, indicates the product's minimum threshold. Product Levels ATUM |
available_to_purchase |
number | If the product is a BOM, indicates the product's available to purchase amount. Product Levels ATUM |
selling_priority |
integer | If the product is a BOM, indicates the product's selling priority. Product Levels ATUM |
calculated_stock |
number | If the BOM stock control is enabled and the product has linked BOM, it indicates the calculated stock quantity. Product Levels ATUM |
sync_purchase_price |
boolean | Whether to sync the product's purchase price with the BOM's purchase price. Default is false, Product Levels ATUM |
Product variation - Downloads properties
| Attribute | Type | Description |
|---|---|---|
id |
string | File ID. |
name |
string | File name. |
file |
string | File URL. |
Product variation - Dimensions properties
| Attribute | Type | Description |
|---|---|---|
length |
string | Variation length. |
width |
string | Variation width. |
height |
string | Variation height. |
Product variation - Image properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Image ID. |
date_created |
date-time | The date the image was created, in the site's timezone. read-only |
date_created_gmt |
date-time | The date the image was created, as GMT. read-only |
date_modified |
date-time | The date the image was last modified, in the site's timezone. read-only |
date_modified_gmt |
date-time | The date the image was last modified, as GMT. read-only |
src |
string | Image URL. |
name |
string | Image name. |
alt |
string | Image alternative text. |
Product variation - Attributes properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Attribute ID. |
name |
string | Attribute name. |
option |
string | Selected attribute term name. |
Product variation - Meta data properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Meta ID. read-only |
key |
string | Meta key. |
value |
string | Meta value. |
Product variation - Linked BOM properties ATUM Product Levels
| Attribute | Type | Description |
|---|---|---|
bom_id |
integer | The linked BOM product ID. |
bom_type |
string | The linked BOM product type. Options: raw_material, product_part |
qty |
number | The linked BOM quantity. |
delete |
boolean | Whether to delete the linked BOM from the product. write-only |
Create a product variation
This API helps you to create a new product variation.
HTTP request
POST
/wp-json/wc/v3/products/<product_id>/variations
JSON response example:
curl -X POST https://example.com/wp-json/wc/v3/products/22/variations \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"regular_price": "9.00",
"purchase_price": 6.5,
"atum_controlled": true,
"image": {
"id": 48
},
"attributes": [
{
"id": 1,
"name": "color",
"option": "Purple"
}
]
}'
const data = {
regular_price: "9.00",
purchase_price: 6.5,
atum_controlled: true,
image: {
id: 48
},
attributes: [
{
id: 1,
name: "color",
option: "Purple"
}
]
};
WooCommerce.post("products/22/variations", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'regular_price' => '9.00',
'purchase_price' => 6.5,
'atum_controlled' => true,
'image' => [
'id' => 48
],
'attributes' => [
[
'id' => 1,
'name' => 'color',
'option' => 'Purple'
]
]
];
print_r($woocommerce->post('products/22/variations', $data));
?>
data = {
"regular_price": "9.00",
"purchase_price": 6.5,
"atum_controlled": true,
"image": {
"id": 48
},
"attributes": [
{
"id": 1,
"name": "color",
"option": "Purple"
}
]
}
print(wcapi.post("products/22/variations", data).json())
data = {
regular_price: "9.00",
purchase_price: 6.5,
atum_controlled: true,
image: {
id: 48
},
attributes: [
{
id: 1,
name: "color",
option: "Purple"
}
]
}
woocommerce.post("products/22/variations", data).parsed_response
JSON response example:
{
"id": 2131,
"date_created": "2019-11-08T09:00:34",
"date_created_gmt": "2019-11-08T08:00:34",
"date_modified": "2019-11-08T09:00:34",
"date_modified_gmt": "2019-11-08T08:00:34",
"description": "",
"permalink": "https://example.com/product/ship-your-idea/?attribute_pa_color=purple",
"sku": "",
"price": "9.00",
"regular_price": "9.00",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"on_sale": false,
"status": "publish",
"purchasable": true,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"tax_status": "taxable",
"tax_class": "",
"manage_stock": "parent",
"stock_quantity": 0,
"stock_status": "instock",
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_class": "",
"shipping_class_id": 0,
"image": {
"id": 48,
"date_created": "2013-06-07T13:01:23",
"date_created_gmt": "2013-06-07T11:01:23",
"date_modified": "2013-06-07T13:01:23",
"date_modified_gmt": "2013-06-07T11:01:23",
"src": "https://example.com/wp-content/uploads/2013/06/hoodie_2_front.jpg",
"name": "hoodie_2_front",
"alt": ""
},
"attributes": [
{
"id": 1,
"name": "color",
"option": "Purple"
}
],
"menu_order": 0,
"meta_data": [],
"purchase_price": 6.5,
"supplier_id": 0,
"supplier_sku": "",
"barcode": "",
"atum_controlled": true,
"out_stock_date": null,
"out_stock_threshold": 0,
"inbound_stock": null,
"stock_on_hold": null,
"sold_today": null,
"sales_last_days": null,
"reserved_stock": null,
"customer_returns": null,
"warehouse_damage": null,
"lost_in_post": null,
"other_logs": null,
"out_stock_days": null,
"lost_sales": null,
"update_date": "2019-11-08T07:00:34",
"linked_bom": [],
"sync_purchase_price": false,
"mi_inventories": [],
"multi_inventory": "global",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/22/variations/2131"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/22/variations"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/22"
}
]
}
}
Retrieve a product variation
This API lets you retrieve and view a specific product variation by ID.
HTTP request
GET
/wp-json/wc/v3/products/<product_id>/variations/<id>
curl https://example.com/wp-json/wc/v3/products/22/variations/23 \
-u consumer_key:consumer_secret
WooCommerce.get("products/22/variations/23")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('products/22/variations/23')); ?>
print(wcapi.get("products/22/variations/23").json())
woocommerce.get("products/22/variations/23").parsed_response
JSON response example:
{
"id": 23,
"date_created": "2013-06-07T12:44:57",
"date_created_gmt": "2013-06-07T10:44:57",
"date_modified": "2019-11-08T09:00:04",
"date_modified_gmt": "2019-11-08T08:00:04",
"description": "",
"permalink": "https://example.com/product/ship-your-idea/?attribute_pa_color=black",
"sku": "",
"price": "20",
"regular_price": "20",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"on_sale": false,
"status": "publish",
"purchasable": true,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"tax_status": "taxable",
"tax_class": "",
"manage_stock": "parent",
"stock_quantity": 9,
"stock_status": "instock",
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_class": "",
"shipping_class_id": 0,
"image": {
"id": 29,
"date_created": "2013-06-07T12:45:30",
"date_created_gmt": "2013-06-07T10:45:30",
"date_modified": "2013-06-07T12:45:30",
"date_modified_gmt": "2013-06-07T10:45:30",
"src": "https://example.com/wp-content/uploads/2013/06/T_4_front1.jpg",
"name": "T_4_front",
"alt": ""
},
"attributes": [
{
"id": 1,
"name": "color",
"option": "Black"
}
],
"menu_order": 2,
"meta_data": [],
"purchase_price": 8,
"supplier_id": 399,
"supplier_sku": "",
"barcode": "",
"atum_controlled": true,
"out_stock_date": null,
"out_stock_threshold": 0,
"inbound_stock": 2,
"stock_on_hold": 3,
"sold_today": 0,
"sales_last_days": 2,
"reserved_stock": 0,
"customer_returns": 0,
"warehouse_damage": 0,
"lost_in_post": 0,
"other_logs": 0,
"out_stock_days": 0,
"lost_sales": 0,
"update_date": "2019-11-08T07:00:06",
"linked_bom": [
{
"bom_id": 551,
"bom_type": "raw_material",
"qty": 1
}
],
"sync_purchase_price": false,
"calculated_stock": 9,
"mi_inventories": [],
"multi_inventory": "no",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/22/variations/23"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/22/variations"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/22"
}
]
}
}
List all product variations
This API helps you to view all the product variations.
HTTP request
GET
/wp-json/wc/v3/products/<product_id>/variations
curl https://example.com/wp-json/wc/v3/products/22/variations \
-u consumer_key:consumer_secret
WooCommerce.get("products/22/variations")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('products/22/variations')); ?>
print(wcapi.get("products/22/variations").json())
woocommerce.get("products/22/variations").parsed_response
JSON response example:
[
{
"id": 2131,
"date_created": "2019-11-08T09:00:34",
"date_created_gmt": "2019-11-08T08:00:34",
"date_modified": "2019-11-08T09:00:59",
"date_modified_gmt": "2019-11-08T08:00:59",
"description": "",
"permalink": "https://example.com/product/ship-your-idea/?attribute_pa_color=purple",
"sku": "",
"price": "9.00",
"regular_price": "9.00",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"on_sale": false,
"status": "publish",
"purchasable": true,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"tax_status": "taxable",
"tax_class": "",
"manage_stock": "parent",
"stock_quantity": 0,
"stock_status": "outofstock",
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_class": "",
"shipping_class_id": 0,
"image": {
"id": 48,
"date_created": "2013-06-07T13:01:23",
"date_created_gmt": "2013-06-07T11:01:23",
"date_modified": "2013-06-07T13:01:23",
"date_modified_gmt": "2013-06-07T11:01:23",
"src": "https://example.com/wp-content/uploads/2013/06/hoodie_2_front.jpg",
"name": "hoodie_2_front",
"alt": ""
},
"attributes": [
{
"id": 1,
"name": "color",
"option": "Purple"
}
],
"menu_order": 0,
"meta_data": [],
"purchase_price": 6.5,
"supplier_id": 0,
"supplier_sku": "",
"barcode": "",
"atum_controlled": false,
"out_stock_date": null,
"out_stock_threshold": 0,
"inbound_stock": null,
"stock_on_hold": null,
"sold_today": null,
"sales_last_days": null,
"reserved_stock": null,
"customer_returns": null,
"warehouse_damage": null,
"lost_in_post": null,
"other_logs": null,
"out_stock_days": null,
"lost_sales": null,
"update_date": "2019-11-08T07:00:59",
"linked_bom": [],
"sync_purchase_price": false,
"mi_inventories": [],
"multi_inventory": "global",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/22/variations/2131"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/22/variations"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/22"
}
]
}
},
{
"id": 24,
"date_created": "2013-06-07T12:44:58",
"date_created_gmt": "2013-06-07T10:44:58",
"date_modified": "2019-11-08T09:00:06",
"date_modified_gmt": "2019-11-08T08:00:06",
"description": "",
"permalink": "https://example.com/product/ship-your-idea/?attribute_pa_color=green",
"sku": "",
"price": "20",
"regular_price": "20",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"on_sale": false,
"status": "publish",
"purchasable": true,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"tax_status": "taxable",
"tax_class": "",
"manage_stock": true,
"stock_quantity": 4,
"stock_status": "instock",
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_class": "",
"shipping_class_id": 0,
"image": {
"id": 27,
"date_created": "2013-06-07T12:45:27",
"date_created_gmt": "2013-06-07T10:45:27",
"date_modified": "2013-06-07T12:45:27",
"date_modified_gmt": "2013-06-07T10:45:27",
"src": "https://example.com/wp-content/uploads/2013/06/T_3_front.jpg",
"name": "T_3_front",
"alt": ""
},
"attributes": [
{
"id": 1,
"name": "color",
"option": "Green"
}
],
"menu_order": 2,
"meta_data": [],
"purchase_price": 12,
"supplier_id": 386,
"supplier_sku": "",
"barcode": "",
"atum_controlled": true,
"out_stock_date": null,
"out_stock_threshold": 0,
"inbound_stock": 1,
"stock_on_hold": 0,
"sold_today": 0,
"sales_last_days": 0,
"reserved_stock": 0,
"customer_returns": 0,
"warehouse_damage": 0,
"lost_in_post": 1,
"other_logs": 1,
"out_stock_days": 0,
"lost_sales": 0,
"update_date": "2019-11-08T07:00:06",
"linked_bom": [],
"sync_purchase_price": false,
"mi_inventories": [],
"multi_inventory": "no",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/22/variations/24"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/22/variations"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/22"
}
]
}
},
{
"id": 23,
"date_created": "2013-06-07T12:44:57",
"date_created_gmt": "2013-06-07T10:44:57",
"date_modified": "2019-11-08T09:00:04",
"date_modified_gmt": "2019-11-08T08:00:04",
"description": "",
"permalink": "https://example.com/product/ship-your-idea/?attribute_pa_color=black",
"sku": "",
"price": "20",
"regular_price": "20",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"on_sale": false,
"status": "publish",
"purchasable": true,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"tax_status": "taxable",
"tax_class": "",
"manage_stock": "parent",
"stock_quantity": 9,
"stock_status": "instock",
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_class": "",
"shipping_class_id": 0,
"image": {
"id": 29,
"date_created": "2013-06-07T12:45:30",
"date_created_gmt": "2013-06-07T10:45:30",
"date_modified": "2013-06-07T12:45:30",
"date_modified_gmt": "2013-06-07T10:45:30",
"src": "https://example.com/wp-content/uploads/2013/06/T_4_front1.jpg",
"name": "T_4_front",
"alt": ""
},
"attributes": [
{
"id": 1,
"name": "color",
"option": "Black"
}
],
"menu_order": 2,
"meta_data": [],
"purchase_price": 8,
"supplier_id": 399,
"supplier_sku": "",
"barcode": "",
"atum_controlled": true,
"out_stock_date": null,
"out_stock_threshold": 0,
"inbound_stock": 2,
"stock_on_hold": 3,
"sold_today": 0,
"sales_last_days": 2,
"reserved_stock": 0,
"customer_returns": 0,
"warehouse_damage": 0,
"lost_in_post": 0,
"other_logs": 0,
"out_stock_days": 0,
"lost_sales": 0,
"update_date": "2019-11-08T07:00:06",
"linked_bom": [
{
"bom_id": 551,
"bom_type": "raw_material",
"qty": 1
}
],
"sync_purchase_price": false,
"calculated_stock": 9,
"mi_inventories": [],
"multi_inventory": "no",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/22/variations/23"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/22/variations"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/22"
}
]
}
}
]
Available parameters
| Parameter | Type | Description |
|---|---|---|
context |
string | Scope under which the request is made; determines fields present in response. Options: view and edit. Default is view. |
page |
integer | Current page of the collection. Default is 1. |
per_page |
integer | Maximum number of items to be returned in result set. Default is 10. |
search |
string | Limit results to those matching a string. |
after |
string | Limit response to resources published after a given ISO8601 compliant date. |
before |
string | Limit response to resources published before a given ISO8601 compliant date. |
modified_after |
string | Limit response to resources modified after a given ISO8601 compliant date. |
modified_before |
string | Limit response to resources modified before a given ISO8601 compliant date. |
exclude |
array | Ensure result set excludes specific IDs. |
include |
array | Limit result set to specific ids. |
offset |
integer | Offset the result set by a specific number of items. |
order |
string | Order sort attribute ascending or descending. Options: asc and desc. Default is desc. |
orderby |
string | Sort collection by object attribute. Options: date, id, include, title and slug. Default is date. |
parent |
array | Limit result set to those of particular parent IDs. |
parent_exclude |
array | Limit result set to all items except those of a particular parent ID. |
slug |
string | Limit result set to products with a specific slug. |
status |
string | Limit result set to products assigned a specific status. Options: any, draft, pending, private and publish. Default is any. |
sku |
string | Limit result set to products with a specific SKU. |
tax_class |
string | Limit result set to products with a specific tax class. Default options: standard, reduced-rate and zero-rate. |
on_sale |
boolean | Limit result set to products on sale. |
min_price |
string | Limit result set to products based on a minimum price. |
max_price |
string | Limit result set to products based on a maximum price. |
stock_status |
string | Limit result set to products with specified stock status. Options: instock, outofstock and onbackorder. |
atum_controlled |
boolean | Limit result set to products controlled by ATUM. ATUM |
atum_min_purchase_price |
number | Limit result set to products based on a minimum purchase price. ATUM |
atum_max_purchase_price |
number | Limit result set to products based on a maximum purchase price. ATUM |
atum_supplier |
integer | Limit result set to products linked to the specified Supplier ID. ATUM |
atum_supplier_sku |
string | Limit result set to products with a specific Supplier SKU. ATUM |
atum_barcode |
string | Limit result set to products with a specific barcode. ATUM |
atum_multi_inventory |
string | Limit result set to products with a specific Multi-Inventory status. Options: yes, no and global. Multi-Inventory ATUM |
atum_inventory_sorting_mode |
string | Limit result set to products with a specific inventory sorting mode. Options: fifo, lifo, bbe, manual and global. Multi-Inventory ATUM |
atum_inventory_iteration |
string | Limit result set to products with a specific inventory iteration. Options: use_next, out_of_stock and global. Multi-Inventory ATUM |
atum_expirable_inventories |
string | Limit result set to products with a specific expirable inventories option. Options: yes, no and global. Multi-Inventory ATUM |
atum_price_per_inventory |
string | Limit result set to products with a specific price per inventory option. Options: yes, no and global. Multi-Inventory ATUM |
atum_bom_sellable |
boolean | Limit result set to sellable BOM products. It should be used in conjunction with the type set to any BOM type. Product Levels ATUM |
List all variations
This API helps you to view all the variations (no matter its parent product).
HTTP request
GET
/wp-json/wc/v3/atum/products-variations
curl https://example.com/wp-json/wc/v3/atum/products-variations \
-u consumer_key:consumer_secret
WooCommerce.get("atum/products-variations")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('atum/products-variations')); ?>
print(wcapi.get("atum/products-variations").json())
woocommerce.get("atum/products-variations").parsed_response
JSON response example:
[
{
"id": 2969,
"date_created": "2021-04-13T13:13:34",
"date_created_gmt": "2021-04-13T11:13:34",
"date_modified": "2021-04-13T13:20:12",
"date_modified_gmt": "2021-04-13T11:20:12",
"description": "",
"permalink": "http://example.com/product/testing-variation-fields/?attribute_pa_color=orange",
"sku": "",
"price": "",
"regular_price": "",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"on_sale": false,
"status": "publish",
"purchasable": false,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"tax_status": "taxable",
"tax_class": "",
"manage_stock": true,
"stock_quantity": 0,
"stock_status": "outofstock",
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"low_stock_amount": "",
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_class": "",
"shipping_class_id": 0,
"image": null,
"attributes": [
{
"id": 1,
"name": "color",
"option": "Orange"
}
],
"menu_order": 2,
"meta_data": [],
"purchase_price": null,
"supplier_id": null,
"supplier_sku": "",
"barcode": "",
"atum_controlled": true,
"out_stock_date": null,
"out_stock_threshold": null,
"inbound_stock": null,
"stock_on_hold": 0,
"sold_today": 0,
"sales_last_days": 0,
"reserved_stock": null,
"customer_returns": null,
"warehouse_damage": null,
"lost_in_post": null,
"other_logs": null,
"out_stock_days": 0,
"lost_sales": 0,
"update_date": "2021-04-21T05:39:48",
"atum_stock_status": "outofstock",
"low_stock": false,
"linked_bom": [],
"sync_purchase_price": false,
"bom_sellable": null,
"minimum_threshold": null,
"available_to_purchase": null,
"selling_priority": null,
"calculated_stock": null,
"is_bom": false,
"mi_inventories": [],
"multi_inventory": "global",
"parent_id": 2966,
"_links": {
"self": [
{
"href": "http://example.com/wp-json/wc/v3/products/2966/variations/2969"
}
],
"collection": [
{
"href": "http://example.com/wp-json/wc/v3/products/2966/variations"
}
],
"up": [
{
"href": "http://example.com/wp-json/wc/v3/products/2966"
}
]
}
},
{
"id": 2968,
"date_created": "2021-04-13T13:13:34",
"date_created_gmt": "2021-04-13T11:13:34",
"date_modified": "2021-04-13T13:20:12",
"date_modified_gmt": "2021-04-13T11:20:12",
"description": "",
"permalink": "http://example.com/product/testing-variation-fields/?attribute_pa_color=blue",
"sku": "",
"price": "",
"regular_price": "",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"on_sale": false,
"status": "publish",
"purchasable": false,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"tax_status": "taxable",
"tax_class": "",
"manage_stock": true,
"stock_quantity": 0,
"stock_status": "outofstock",
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"low_stock_amount": "",
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_class": "",
"shipping_class_id": 0,
"image": null,
"attributes": [
{
"id": 1,
"name": "color",
"option": "Blue"
}
],
"menu_order": 1,
"meta_data": [],
"purchase_price": null,
"supplier_id": null,
"supplier_sku": "",
"barcode": "",
"atum_controlled": true,
"out_stock_date": null,
"out_stock_threshold": null,
"inbound_stock": null,
"stock_on_hold": 0,
"sold_today": 0,
"sales_last_days": 0,
"reserved_stock": null,
"customer_returns": null,
"warehouse_damage": null,
"lost_in_post": null,
"other_logs": null,
"out_stock_days": 0,
"lost_sales": 0,
"update_date": "2021-04-21T05:39:48",
"atum_stock_status": "outofstock",
"low_stock": false,
"linked_bom": [],
"sync_purchase_price": false,
"bom_sellable": null,
"minimum_threshold": null,
"available_to_purchase": null,
"selling_priority": null,
"calculated_stock": null,
"is_bom": false,
"mi_inventories": [],
"multi_inventory": "global",
"parent_id": 2966,
"_links": {
"self": [
{
"href": "http://example.com/wp-json/wc/v3/products/2966/variations/2968"
}
],
"collection": [
{
"href": "http://example.com/wp-json/wc/v3/products/2966/variations"
}
],
"up": [
{
"href": "http://example.com/wp-json/wc/v3/products/2966"
}
]
}
},
{
"id": 2889,
"date_created": "2021-02-02T09:36:01",
"date_created_gmt": "2021-02-02T08:36:01",
"date_modified": "2021-02-02T09:37:51",
"date_modified_gmt": "2021-02-02T08:37:51",
"description": "",
"permalink": "http://example.com/product/variable-test/?attribute_pa_color=purple",
"sku": "",
"price": "",
"regular_price": "",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"on_sale": false,
"status": "publish",
"purchasable": false,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"tax_status": "taxable",
"tax_class": "",
"manage_stock": "parent",
"stock_quantity": 0,
"stock_status": "outofstock",
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"low_stock_amount": "",
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_class": "",
"shipping_class_id": 0,
"image": null,
"attributes": [
{
"id": 1,
"name": "color",
"option": "Purple"
}
],
"menu_order": 3,
"meta_data": [],
"purchase_price": null,
"supplier_id": null,
"supplier_sku": "",
"barcode": "",
"atum_controlled": false,
"out_stock_date": null,
"out_stock_threshold": null,
"inbound_stock": null,
"stock_on_hold": 0,
"sold_today": 0,
"sales_last_days": 0,
"reserved_stock": null,
"customer_returns": null,
"warehouse_damage": null,
"lost_in_post": null,
"other_logs": null,
"out_stock_days": 0,
"lost_sales": 0,
"update_date": "2021-04-21T05:39:48",
"atum_stock_status": "outofstock",
"low_stock": false,
"linked_bom": [],
"sync_purchase_price": false,
"bom_sellable": null,
"minimum_threshold": null,
"available_to_purchase": null,
"selling_priority": null,
"calculated_stock": null,
"is_bom": false,
"mi_inventories": [],
"multi_inventory": "global",
"parent_id": 505,
"_links": {
"self": [
{
"href": "http://example.com/wp-json/wc/v3/products/505/variations/2889"
}
],
"collection": [
{
"href": "http://example.com/wp-json/wc/v3/products/505/variations"
}
],
"up": [
{
"href": "http://example.com/wp-json/wc/v3/products/505"
}
]
}
}
]
Available parameters
| Parameter | Type | Description |
|---|---|---|
context |
string | Scope under which the request is made; determines fields present in response. Options: view and edit. Default is view. |
page |
integer | Current page of the collection. Default is 1. |
per_page |
integer | Maximum number of items to be returned in result set. Default is 10. |
search |
string | Limit results to those matching a string. |
after |
string | Limit response to resources published after a given ISO8601 compliant date. |
before |
string | Limit response to resources published before a given ISO8601 compliant date. |
modified_after |
string | Limit response to resources modified after a given ISO8601 compliant date. |
modified_before |
string | Limit response to resources modified before a given ISO8601 compliant date. |
exclude |
array | Ensure result set excludes specific IDs. |
include |
array | Limit result set to specific ids. |
offset |
integer | Offset the result set by a specific number of items. |
order |
string | Order sort attribute ascending or descending. Options: asc and desc. Default is desc. |
orderby |
string | Sort collection by object attribute. Options: date, id, include, title and slug. Default is date. |
parent |
array | Limit result set to those of particular parent IDs. |
parent_exclude |
array | Limit result set to all items except those of a particular parent ID. |
slug |
string | Limit result set to products with a specific slug. |
status |
string | Limit result set to products assigned a specific status. Options: any, draft, pending, private and publish. Default is any. |
sku |
string | Limit result set to products with a specific SKU. |
tax_class |
string | Limit result set to products with a specific tax class. Default options: standard, reduced-rate and zero-rate. |
on_sale |
boolean | Limit result set to products on sale. |
min_price |
string | Limit result set to products based on a minimum price. |
max_price |
string | Limit result set to products based on a maximum price. |
stock_status |
string | Limit result set to products with specified stock status. Options: instock, outofstock and onbackorder. |
atum_controlled |
boolean | Limit result set to products controlled by ATUM. ATUM |
min_purchase_price |
number | Limit result set to products based on a minimum purchase price. ATUM |
max_purchase_price |
number | Limit result set to products based on a maximum purchase price. ATUM |
supplier |
integer | Limit result set to products linked to the specified Supplier ID. ATUM |
supplier_sku |
string | Limit result set to products with a specific Supplier SKU. ATUM |
barcode |
string | Limit result set to products with a specific barcode. ATUM |
multi_inventory |
string | Limit result set to products with a specific Multi-Inventory status. Options: yes, no and global. Multi-Inventory ATUM |
inventory_sorting_mode |
string | Limit result set to products with a specific inventory sorting mode. Options: fifo, lifo, bbe, manual and global. Multi-Inventory ATUM |
inventory_iteration |
string | Limit result set to products with a specific inventory iteration. Options: use_next, out_of_stock and global. Multi-Inventory ATUM |
expirable_inventories |
string | Limit result set to products with a specific expirable inventories option. Options: yes, no and global. Multi-Inventory ATUM |
price_per_inventory |
string | Limit result set to products with a specific price per inventory option. Options: yes, no and global. Multi-Inventory ATUM |
bom_sellable |
boolean | Limit result set to sellable BOM products. It should be used in conjunction with the type set to any BOM type. Product Levels ATUM |
Update a product variation
This API lets you make changes to a product variation.
HTTP request
PUT
/wp-json/wc/v3/products/<product_id>/variations/<id>
curl -X PUT https://example.com/wp-json/wc/v3/products/22/variations/23 \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"multi_inventory": "yes",
"inventory_sorting_mode": "bbe",
"inventory_iteration": "use_next",
"expirable_inventories": "yes",
"price_per_inventory": "yes"
}'
const data = {
multi_inventory: "yes",
inventory_sorting_mode: "bbe",
inventory_iteration: "use_next",
expirable_inventories: "yes",
price_per_inventory: "yes"
};
WooCommerce.put("products/22/variations/23", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'multi_inventory' => 'yes',
'inventory_sorting_mode' => 'bbe',
'inventory_iteration' => 'use_next',
'expirable_inventories' => 'yes',
'price_per_inventory' => 'yes'
];
print_r($woocommerce->put('products/22/variations/23', $data));
?>
data = {
"multi_inventory": "yes",
"inventory_sorting_mode": "bbe",
"inventory_iteration": "use_next",
"expirable_inventories": "yes",
"price_per_inventory": "yes"
}
print(wcapi.put("products/22/variations/23", data).json())
data = {
multi_inventory: "yes",
inventory_sorting_mode: "bbe",
inventory_iteration: "use_next",
expirable_inventories: "yes",
price_per_inventory: "yes"
}
woocommerce.put("products/22/variations/23", data).parsed_response
JSON response example:
{
"id": 23,
"date_created": "2013-06-07T12:44:57",
"date_created_gmt": "2013-06-07T10:44:57",
"date_modified": "2019-11-08T10:22:13",
"date_modified_gmt": "2019-11-08T09:22:13",
"description": "",
"permalink": "https://example.com/product/ship-your-idea/?attribute_pa_color=black",
"sku": "",
"price": null,
"regular_price": null,
"sale_price": null,
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"on_sale": false,
"status": "publish",
"purchasable": true,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"tax_status": "taxable",
"tax_class": "",
"manage_stock": true,
"stock_quantity": 0,
"stock_status": "outofstock",
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_class": "",
"shipping_class_id": 0,
"image": {
"id": 29,
"date_created": "2013-06-07T12:45:30",
"date_created_gmt": "2013-06-07T10:45:30",
"date_modified": "2013-06-07T12:45:30",
"date_modified_gmt": "2013-06-07T10:45:30",
"src": "https://example.com/wp-content/uploads/2013/06/T_4_front1.jpg",
"name": "T_4_front",
"alt": ""
},
"attributes": [
{
"id": 1,
"name": "color",
"option": "Black"
}
],
"menu_order": 2,
"meta_data": [],
"purchase_price": 8,
"supplier_id": 399,
"supplier_sku": "",
"barcode": "",
"atum_controlled": true,
"out_stock_date": null,
"out_stock_threshold": 0,
"inbound_stock": 2,
"stock_on_hold": 3,
"sold_today": 0,
"sales_last_days": 2,
"reserved_stock": 0,
"customer_returns": 0,
"warehouse_damage": 0,
"lost_in_post": 0,
"other_logs": 0,
"out_stock_days": 0,
"lost_sales": 0,
"update_date": "2019-11-08T07:00:06",
"linked_bom": [
{
"bom_id": 551,
"bom_type": "raw_material",
"qty": 1
}
],
"sync_purchase_price": false,
"calculated_stock": 9,
"mi_inventories": [
81
],
"multi_inventory": "yes",
"inventory_sorting_mode": "bbe",
"inventory_iteration": "use_next",
"expirable_inventories": "yes",
"price_per_inventory": "yes",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/22/variations/23"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/22/variations"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/22"
}
]
}
}
Delete a product variation
This API helps you delete a product variation.
HTTP request
DELETE
/wp-json/wc/v3/products/<product_id>/variations/<id>
curl -X DELETE https://example.com/wp-json/wc/v3/products/22/variations/2131?force=true \
-u consumer_key:consumer_secret
WooCommerce.delete("products/22/variations/2131", {
force: true
})
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->delete('products/22/variations/2131', ['force' => true])); ?>
print(wcapi.delete("products/22/variations/2131", params={"force": True}).json())
woocommerce.delete("products/22/variations/2131", force: true).parsed_response
JSON response example:
{
"id": 2131,
"date_created": "2019-11-08T09:00:34",
"date_created_gmt": "2019-11-08T08:00:34",
"date_modified": "2019-11-08T09:00:59",
"date_modified_gmt": "2019-11-08T08:00:59",
"description": "",
"permalink": "https://example.com/product/ship-your-idea/?attribute_pa_color=purple",
"sku": "",
"price": "9.00",
"regular_price": "9.00",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"on_sale": false,
"status": "publish",
"purchasable": true,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"tax_status": "taxable",
"tax_class": "",
"manage_stock": "parent",
"stock_quantity": 0,
"stock_status": "outofstock",
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_class": "",
"shipping_class_id": 0,
"image": {
"id": 48,
"date_created": "2013-06-07T13:01:23",
"date_created_gmt": "2013-06-07T11:01:23",
"date_modified": "2013-06-07T13:01:23",
"date_modified_gmt": "2013-06-07T11:01:23",
"src": "https://example.com/wp-content/uploads/2013/06/hoodie_2_front.jpg",
"name": "hoodie_2_front",
"alt": ""
},
"attributes": [
{
"id": 1,
"name": "color",
"option": "Purple"
}
],
"menu_order": 0,
"meta_data": [],
"purchase_price": 6.5,
"supplier_id": 0,
"supplier_sku": "",
"barcode": "",
"atum_controlled": false,
"out_stock_date": null,
"out_stock_threshold": 0,
"inbound_stock": null,
"stock_on_hold": null,
"sold_today": null,
"sales_last_days": null,
"reserved_stock": null,
"customer_returns": null,
"warehouse_damage": null,
"lost_in_post": null,
"other_logs": null,
"out_stock_days": null,
"lost_sales": null,
"update_date": "2019-11-08T07:00:59",
"linked_bom": [],
"sync_purchase_price": false,
"mi_inventories": [],
"multi_inventory": "global",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/22/variations/2131"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/22/variations"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/22"
}
]
}
}
Available parameters
| Parameter | Type | Description |
|---|---|---|
force |
string | Required to be true, as resource does not support trashing. |
Batch update product variations
This API helps you to batch create, update and delete multiple product variations.
HTTP request
POST
/wp-json/wc/v3/products/<product_id>/variations/batch
curl -X POST https://example.com/wp-json/wc/v3/products/22/variations/batch \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"create": [
{
"regular_price": "10.00",
"atum_controlled": true,
"attributes": [
{
"id": 1,
"name": "color",
"option": "Purple"
}
]
},
{
"regular_price": "11.00",
"atum_controlled": true,
"attributes": [
{
"id": 1,
"name": "color",
"option": "Orange"
}
]
}
],
"update": [
{
"id": 24,
"supplier_id": 399,
"supplier_sku": "VARSKU"
}
],
"delete": [
2132
]
}'
const data = {
create: [
{
regular_price: "10.00",
atum_controlled: true,
attributes: [
{
id: 1,
name: "color",
option: "Purple"
}
]
},
{
regular_price: "11.00",
atum_controlled: true,
attributes: [
{
id: 1,
name: "color",
option: "Orange"
}
]
}
],
update: [
{
id: 24,
supplier_id: 399,
supplier_sku: "VARSKU"
}
],
delete: [
2132
]
};
WooCommerce.post("products/22/variations/batch", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'create' => [
[
'regular_price' => '10.00',
'atum_controlled' => true,
'attributes' => [
[
'id' => 1,
'name' => 'color',
'option' => 'Purple'
]
]
],
[
'regular_price' => '11.00',
'atum_controlled' => true,
'attributes' => [
[
'id' => 1,
'name' => 'color',
'option' => 'Orange'
]
]
]
],
'update' => [
[
'id' => 24,
'supplier_id' => 399,
'supplier_sku' => 'VARSKU'
]
],
'delete' => [
2132
]
];
print_r($woocommerce->post('products/22/variations/batch', $data));
?>
data = {
"create": [
{
"regular_price": "10.00",
"atum_controlled": true,
"attributes": [
{
"id": 1,
"name": "color",
"option": "Purple"
}
]
},
{
"regular_price": "11.00",
"atum_controlled": true,
"attributes": [
{
"id": 1,
"name": "color",
"option": "Orange"
}
]
}
],
"update": [
{
"id": 24,
"supplier_id": 399,
"supplier_sku": "VARSKU"
}
],
"delete": [
2132
]
}
print(wcapi.post("products/22/variations/batch", data).json())
data = {
create: [
{
regular_price: "10.00",
atum_controlled: true,
attributes: [
{
id: 1,
name: "color",
option: "Purple"
}
]
},
{
regular_price: "11.00",
atum_controlled: true,
attributes: [
{
id: 1,
name: "color",
option: "Orange"
}
]
}
],
update: [
{
id: 24,
supplier_id: 399,
supplier_sku: "VARSKU"
}
],
delete: [
2132
]
}
woocommerce.post("products/22/variations/batch", data).parsed_response
JSON response example:
{
"create": [
{
"id": 2133,
"date_created": "2019-11-08T10:52:24",
"date_created_gmt": "2019-11-08T09:52:24",
"date_modified": "2019-11-08T10:52:24",
"date_modified_gmt": "2019-11-08T09:52:24",
"description": "",
"permalink": "https://example.com/product/ship-your-idea/?attribute_pa_color=purple",
"sku": "",
"price": "10.00",
"regular_price": "10.00",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"on_sale": false,
"status": "publish",
"purchasable": true,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"tax_status": "taxable",
"tax_class": "",
"manage_stock": "parent",
"stock_quantity": 0,
"stock_status": "instock",
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_class": "",
"shipping_class_id": 0,
"image": {
"id": 25,
"date_created": "2013-06-07T12:45:14",
"date_created_gmt": "2013-06-07T10:45:14",
"date_modified": "2013-06-07T12:45:14",
"date_modified_gmt": "2013-06-07T10:45:14",
"src": "https://example.com/wp-content/uploads/2013/06/T_4_front.jpg",
"name": "T_4_front",
"alt": ""
},
"attributes": [
{
"id": 1,
"name": "color",
"option": "Purple"
}
],
"menu_order": 0,
"meta_data": [],
"purchase_price": 0,
"supplier_id": 0,
"supplier_sku": "",
"barcode": "",
"atum_controlled": true,
"out_stock_date": null,
"out_stock_threshold": 0,
"inbound_stock": null,
"stock_on_hold": null,
"sold_today": null,
"sales_last_days": null,
"reserved_stock": null,
"customer_returns": null,
"warehouse_damage": null,
"lost_in_post": null,
"other_logs": null,
"out_stock_days": null,
"lost_sales": null,
"update_date": "2019-11-08T08:52:25",
"linked_bom": [],
"sync_purchase_price": false,
"mi_inventories": [],
"multi_inventory": "global",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/22/variations/2133"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/22/variations"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/22"
}
]
}
},
{
"id": 2134,
"date_created": "2019-11-08T10:52:26",
"date_created_gmt": "2019-11-08T09:52:26",
"date_modified": "2019-11-08T10:52:26",
"date_modified_gmt": "2019-11-08T09:52:26",
"description": "",
"permalink": "https://example.com/product/ship-your-idea/?attribute_pa_color=orange",
"sku": "",
"price": "11.00",
"regular_price": "11.00",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"on_sale": false,
"status": "publish",
"purchasable": true,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"tax_status": "taxable",
"tax_class": "",
"manage_stock": "parent",
"stock_quantity": 0,
"stock_status": "instock",
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_class": "",
"shipping_class_id": 0,
"image": {
"id": 25,
"date_created": "2013-06-07T12:45:14",
"date_created_gmt": "2013-06-07T10:45:14",
"date_modified": "2013-06-07T12:45:14",
"date_modified_gmt": "2013-06-07T10:45:14",
"src": "https://example.com/wp-content/uploads/2013/06/T_4_front.jpg",
"name": "T_4_front",
"alt": ""
},
"attributes": [
{
"id": 1,
"name": "color",
"option": "Orange"
}
],
"menu_order": 0,
"meta_data": [],
"purchase_price": 0,
"supplier_id": 0,
"supplier_sku": "",
"barcode": "",
"atum_controlled": true,
"out_stock_date": null,
"out_stock_threshold": 0,
"inbound_stock": null,
"stock_on_hold": null,
"sold_today": null,
"sales_last_days": null,
"reserved_stock": null,
"customer_returns": null,
"warehouse_damage": null,
"lost_in_post": null,
"other_logs": null,
"out_stock_days": null,
"lost_sales": null,
"update_date": "2019-11-08T08:52:26",
"linked_bom": [],
"sync_purchase_price": false,
"mi_inventories": [],
"multi_inventory": "global",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/22/variations/2134"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/22/variations"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/22"
}
]
}
}
],
"update": [
{
"id": 24,
"date_created": "2013-06-07T12:44:58",
"date_created_gmt": "2013-06-07T10:44:58",
"date_modified": "2019-11-08T10:52:27",
"date_modified_gmt": "2019-11-08T09:52:27",
"description": "",
"permalink": "https://example.com/product/ship-your-idea/?attribute_pa_color=green",
"sku": "",
"price": "20",
"regular_price": "20",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"on_sale": false,
"status": "publish",
"purchasable": true,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"tax_status": "taxable",
"tax_class": "",
"manage_stock": true,
"stock_quantity": 4,
"stock_status": "instock",
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_class": "",
"shipping_class_id": 0,
"image": {
"id": 27,
"date_created": "2013-06-07T12:45:27",
"date_created_gmt": "2013-06-07T10:45:27",
"date_modified": "2013-06-07T12:45:27",
"date_modified_gmt": "2013-06-07T10:45:27",
"src": "https://example.com/wp-content/uploads/2013/06/T_3_front.jpg",
"name": "T_3_front",
"alt": ""
},
"attributes": [
{
"id": 1,
"name": "color",
"option": "Green"
}
],
"menu_order": 2,
"meta_data": [],
"purchase_price": 12,
"supplier_id": 399,
"supplier_sku": "VARSKU",
"barcode": "AAAAOOOOOOP",
"atum_controlled": true,
"out_stock_date": null,
"out_stock_threshold": 0,
"inbound_stock": 1,
"stock_on_hold": 0,
"sold_today": 0,
"sales_last_days": 0,
"reserved_stock": 0,
"customer_returns": 0,
"warehouse_damage": 0,
"lost_in_post": 1,
"other_logs": 1,
"out_stock_days": 0,
"lost_sales": 0,
"update_date": "2019-11-08T08:52:27",
"linked_bom": [],
"sync_purchase_price": false,
"mi_inventories": [],
"multi_inventory": "no",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/22/variations/24"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/22/variations"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/22"
}
]
}
}
],
"delete": [
{
"id": 2132,
"date_created": "2019-11-08T10:51:11",
"date_created_gmt": "2019-11-08T09:51:11",
"date_modified": "2019-11-08T10:51:11",
"date_modified_gmt": "2019-11-08T09:51:11",
"description": "",
"permalink": "https://example.com/product/ship-your-idea/?attribute_pa_color=purple",
"sku": "",
"price": "9.00",
"regular_price": "9.00",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"on_sale": false,
"status": "publish",
"purchasable": true,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"tax_status": "taxable",
"tax_class": "",
"manage_stock": "parent",
"stock_quantity": 0,
"stock_status": "outofstock",
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_class": "",
"shipping_class_id": 0,
"image": {
"id": 48,
"date_created": "2013-06-07T13:01:23",
"date_created_gmt": "2013-06-07T11:01:23",
"date_modified": "2013-06-07T13:01:23",
"date_modified_gmt": "2013-06-07T11:01:23",
"src": "https://example.com/wp-content/uploads/2013/06/hoodie_2_front.jpg",
"name": "hoodie_2_front",
"alt": ""
},
"attributes": [
{
"id": 1,
"name": "color",
"option": "Purple"
}
],
"menu_order": 0,
"meta_data": [],
"purchase_price": 6.5,
"supplier_id": 0,
"supplier_sku": "",
"barcode": "",
"atum_controlled": true,
"out_stock_date": null,
"out_stock_threshold": 0,
"inbound_stock": null,
"stock_on_hold": null,
"sold_today": null,
"sales_last_days": null,
"reserved_stock": null,
"customer_returns": null,
"warehouse_damage": null,
"lost_in_post": null,
"other_logs": null,
"out_stock_days": null,
"lost_sales": null,
"update_date": "2019-11-08T08:51:11",
"linked_bom": [],
"sync_purchase_price": false,
"mi_inventories": [],
"multi_inventory": "global",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/0/variations/2132"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/0/variations"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/0"
}
]
}
}
]
}
Batch update any variations
ATUM
This API helps you to batch create, update and delete multiple product variations and also mixing variations from distinct variables at the same time.
HTTP request
POST
/wp-json/wc/v3/atum/product-variations/batch
curl -X POST https://example.com/wp-json/wc/v3/atum/product-variations/batch \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"create": [
{
"product_id": 22,
"regular_price": "10.00",
"atum_controlled": true,
"attributes": [
{
"id": 1,
"name": "color",
"option": "Purple"
}
]
},
{
"product_id": 22,
"regular_price": "11.00",
"atum_controlled": true,
"attributes": [
{
"id": 1,
"name": "color",
"option": "Orange"
}
]
}
],
"update": [
{
"id": 24,
"supplier_id": 399,
"supplier_sku": "VARSKU"
}
],
"delete": [
2132
]
}'
const data = {
create: [
{
product_id: 22,
regular_price: "10.00",
atum_controlled: true,
attributes: [
{
id: 1,
name: "color",
option: "Purple"
}
]
},
{
product_id: 22,
regular_price: "11.00",
atum_controlled: true,
attributes: [
{
id: 1,
name: "color",
option: "Orange"
}
]
}
],
update: [
{
id: 24,
supplier_id: 399,
supplier_sku: "VARSKU"
}
],
delete: [
2132
]
};
WooCommerce.post("atum/product-variations/batch", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'create' => [
[
'product_id' => 22,
'regular_price' => '10.00',
'atum_controlled' => true,
'attributes' => [
[
'id' => 1,
'name' => 'color',
'option' => 'Purple'
]
]
],
[
'product_id' => 22,
'regular_price' => '11.00',
'atum_controlled' => true,
'attributes' => [
[
'id' => 1,
'name' => 'color',
'option' => 'Orange'
]
]
]
],
'update' => [
[
'id' => 24,
'supplier_id' => 399,
'supplier_sku' => 'VARSKU'
]
],
'delete' => [
2132
]
];
print_r($woocommerce->post('atum/product-variations/batch', $data));
?>
data = {
"create": [
{
"product_id": 22,
"regular_price": "10.00",
"atum_controlled": true,
"attributes": [
{
"id": 1,
"name": "color",
"option": "Purple"
}
]
},
{
"product_id": 22,
"regular_price": "11.00",
"atum_controlled": true,
"attributes": [
{
"id": 1,
"name": "color",
"option": "Orange"
}
]
}
],
"update": [
{
"id": 24,
"supplier_id": 399,
"supplier_sku": "VARSKU"
}
],
"delete": [
2132
]
}
print(wcapi.post("atum/product-variations/batch", data).json())
data = {
create: [
{
product_id: 22,
regular_price: "10.00",
atum_controlled: true,
attributes: [
{
id: 1,
name: "color",
option: "Purple"
}
]
},
{
product_id: 22,
regular_price: "11.00",
atum_controlled: true,
attributes: [
{
id: 1,
name: "color",
option: "Orange"
}
]
}
],
update: [
{
id: 24,
supplier_id: 399,
supplier_sku: "VARSKU"
}
],
delete: [
2132
]
}
woocommerce.post("products/22/variations/batch", data).parsed_response
JSON response example:
{
"create": [
{
"id": 2133,
"date_created": "2019-11-08T10:52:24",
"date_created_gmt": "2019-11-08T09:52:24",
"date_modified": "2019-11-08T10:52:24",
"date_modified_gmt": "2019-11-08T09:52:24",
"description": "",
"permalink": "https://example.com/product/ship-your-idea/?attribute_pa_color=purple",
"sku": "",
"price": "10.00",
"regular_price": "10.00",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"on_sale": false,
"status": "publish",
"purchasable": true,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"tax_status": "taxable",
"tax_class": "",
"manage_stock": "parent",
"stock_quantity": 0,
"stock_status": "instock",
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_class": "",
"shipping_class_id": 0,
"image": {
"id": 25,
"date_created": "2013-06-07T12:45:14",
"date_created_gmt": "2013-06-07T10:45:14",
"date_modified": "2013-06-07T12:45:14",
"date_modified_gmt": "2013-06-07T10:45:14",
"src": "https://example.com/wp-content/uploads/2013/06/T_4_front.jpg",
"name": "T_4_front",
"alt": ""
},
"attributes": [
{
"id": 1,
"name": "color",
"option": "Purple"
}
],
"menu_order": 0,
"meta_data": [],
"purchase_price": 0,
"supplier_id": 0,
"supplier_sku": "",
"barcode": "",
"atum_controlled": true,
"out_stock_date": null,
"out_stock_threshold": 0,
"inbound_stock": null,
"stock_on_hold": null,
"sold_today": null,
"sales_last_days": null,
"reserved_stock": null,
"customer_returns": null,
"warehouse_damage": null,
"lost_in_post": null,
"other_logs": null,
"out_stock_days": null,
"lost_sales": null,
"update_date": "2019-11-08T08:52:25",
"linked_bom": [],
"sync_purchase_price": false,
"mi_inventories": [],
"multi_inventory": "global",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/22/variations/2133"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/22/variations"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/22"
}
]
}
},
{
"id": 2134,
"date_created": "2019-11-08T10:52:26",
"date_created_gmt": "2019-11-08T09:52:26",
"date_modified": "2019-11-08T10:52:26",
"date_modified_gmt": "2019-11-08T09:52:26",
"description": "",
"permalink": "https://example.com/product/ship-your-idea/?attribute_pa_color=orange",
"sku": "",
"price": "11.00",
"regular_price": "11.00",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"on_sale": false,
"status": "publish",
"purchasable": true,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"tax_status": "taxable",
"tax_class": "",
"manage_stock": "parent",
"stock_quantity": 0,
"stock_status": "instock",
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_class": "",
"shipping_class_id": 0,
"image": {
"id": 25,
"date_created": "2013-06-07T12:45:14",
"date_created_gmt": "2013-06-07T10:45:14",
"date_modified": "2013-06-07T12:45:14",
"date_modified_gmt": "2013-06-07T10:45:14",
"src": "https://example.com/wp-content/uploads/2013/06/T_4_front.jpg",
"name": "T_4_front",
"alt": ""
},
"attributes": [
{
"id": 1,
"name": "color",
"option": "Orange"
}
],
"menu_order": 0,
"meta_data": [],
"purchase_price": 0,
"supplier_id": 0,
"supplier_sku": "",
"barcode": "",
"atum_controlled": true,
"out_stock_date": null,
"out_stock_threshold": 0,
"inbound_stock": null,
"stock_on_hold": null,
"sold_today": null,
"sales_last_days": null,
"reserved_stock": null,
"customer_returns": null,
"warehouse_damage": null,
"lost_in_post": null,
"other_logs": null,
"out_stock_days": null,
"lost_sales": null,
"update_date": "2019-11-08T08:52:26",
"linked_bom": [],
"sync_purchase_price": false,
"mi_inventories": [],
"multi_inventory": "global",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/22/variations/2134"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/22/variations"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/22"
}
]
}
}
],
"update": [
{
"id": 24,
"date_created": "2013-06-07T12:44:58",
"date_created_gmt": "2013-06-07T10:44:58",
"date_modified": "2019-11-08T10:52:27",
"date_modified_gmt": "2019-11-08T09:52:27",
"description": "",
"permalink": "https://example.com/product/ship-your-idea/?attribute_pa_color=green",
"sku": "",
"price": "20",
"regular_price": "20",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"on_sale": false,
"status": "publish",
"purchasable": true,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"tax_status": "taxable",
"tax_class": "",
"manage_stock": true,
"stock_quantity": 4,
"stock_status": "instock",
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_class": "",
"shipping_class_id": 0,
"image": {
"id": 27,
"date_created": "2013-06-07T12:45:27",
"date_created_gmt": "2013-06-07T10:45:27",
"date_modified": "2013-06-07T12:45:27",
"date_modified_gmt": "2013-06-07T10:45:27",
"src": "https://example.com/wp-content/uploads/2013/06/T_3_front.jpg",
"name": "T_3_front",
"alt": ""
},
"attributes": [
{
"id": 1,
"name": "color",
"option": "Green"
}
],
"menu_order": 2,
"meta_data": [],
"purchase_price": 12,
"supplier_id": 399,
"supplier_sku": "VARSKU",
"barcode": "AAAAOOOOOOP",
"atum_controlled": true,
"out_stock_date": null,
"out_stock_threshold": 0,
"inbound_stock": 1,
"stock_on_hold": 0,
"sold_today": 0,
"sales_last_days": 0,
"reserved_stock": 0,
"customer_returns": 0,
"warehouse_damage": 0,
"lost_in_post": 1,
"other_logs": 1,
"out_stock_days": 0,
"lost_sales": 0,
"update_date": "2019-11-08T08:52:27",
"linked_bom": [],
"sync_purchase_price": false,
"mi_inventories": [],
"multi_inventory": "no",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/22/variations/24"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/22/variations"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/22"
}
]
}
}
],
"delete": [
{
"id": 2132,
"date_created": "2019-11-08T10:51:11",
"date_created_gmt": "2019-11-08T09:51:11",
"date_modified": "2019-11-08T10:51:11",
"date_modified_gmt": "2019-11-08T09:51:11",
"description": "",
"permalink": "https://example.com/product/ship-your-idea/?attribute_pa_color=purple",
"sku": "",
"price": "9.00",
"regular_price": "9.00",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"on_sale": false,
"status": "publish",
"purchasable": true,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"tax_status": "taxable",
"tax_class": "",
"manage_stock": "parent",
"stock_quantity": 0,
"stock_status": "outofstock",
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_class": "",
"shipping_class_id": 0,
"image": {
"id": 48,
"date_created": "2013-06-07T13:01:23",
"date_created_gmt": "2013-06-07T11:01:23",
"date_modified": "2013-06-07T13:01:23",
"date_modified_gmt": "2013-06-07T11:01:23",
"src": "https://example.com/wp-content/uploads/2013/06/hoodie_2_front.jpg",
"name": "hoodie_2_front",
"alt": ""
},
"attributes": [
{
"id": 1,
"name": "color",
"option": "Purple"
}
],
"menu_order": 0,
"meta_data": [],
"purchase_price": 6.5,
"supplier_id": 0,
"supplier_sku": "",
"barcode": "",
"atum_controlled": true,
"out_stock_date": null,
"out_stock_threshold": 0,
"inbound_stock": null,
"stock_on_hold": null,
"sold_today": null,
"sales_last_days": null,
"reserved_stock": null,
"customer_returns": null,
"warehouse_damage": null,
"lost_in_post": null,
"other_logs": null,
"out_stock_days": null,
"lost_sales": null,
"update_date": "2019-11-08T08:51:11",
"linked_bom": [],
"sync_purchase_price": false,
"mi_inventories": [],
"multi_inventory": "global",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/0/variations/2132"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/0/variations"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/0"
}
]
}
}
]
}
Product locations
ATUM
The ATUM product locations API allows you to create, view, update, and delete individual, or a batch, of locations.
Product location properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Unique identifier for the resource. read-only |
name |
string | Location name. mandatory |
slug |
string | An alphanumeric identifier for the resource unique to its type. |
parent |
integer | The ID for the parent of the resource. |
description |
string | HTML description of the resource. |
count |
integer | Number of published products for the resource. read-only |
barcode |
string | Location's barcode. ATUM |
Create a product location
This API helps you to create a new product location.
HTTP request
POST
/wp-json/wc/v3/products/atum-locations
Example of how to create a product location:
curl -X POST https://example.com/wp-json/wc/v3/products/atum-locations \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"name": "Manchester",
"parent": 38
}'
const data = {
name: "Manchester",
parent: 38
};
WooCommerce.post("products/atum-locations", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'name' => 'Manchester',
'parent' => 38
];
print_r($woocommerce->post('products/atum-locations', $data));
?>
data = {
"name": "Manchester",
"parent": 38
}
print(wcapi.post("products/atum-locations", data).json())
data = {
name: "Manchester",
parent: 38
}
woocommerce.post("products/atum-locations", data).parsed_response
JSON response example:
{
"id": 58,
"name": "Manchester",
"slug": "manchester",
"parent": 38,
"description": "",
"count": 0,
"barcode": "",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations/58"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations/38"
}
]
}
}
Retrieve a product location
This API lets you retrieve a product location by ID.
GET
/wp-json/wc/v3/products/atum-locations/<id>
curl https://example.com/wp-json/wc/v3/products/atum-locations/38 \
-u consumer_key:consumer_secret
WooCommerce.get("products/atum-locations/38")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('products/atum-locations/38')); ?>
print(wcapi.get("products/atum-locations/38").json())
woocommerce.get("products/atum-locations/38").parsed_response
JSON response example:
{
"id": 38,
"name": "United Kingdom",
"slug": "united-kingdom",
"parent": 0,
"description": "",
"count": 7,
"barcode": "",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations/38"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations"
}
]
}
}
List all product locations
This API lets you retrieve all product locations.
GET
/wp-json/wc/v3/products/atum-locations
curl https://example.com/wp-json/wc/v3/products/atum-locations \
-u consumer_key:consumer_secret
WooCommerce.get("products/atum-locations")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('products/atum-locations')); ?>
print(wcapi.get("products/atum-locations").json())
woocommerce.get("products/atum-locations").parsed_response
JSON response example:
[
{
"id": 39,
"name": "Italy",
"slug": "italy",
"parent": 0,
"description": "",
"count": 5,
"barcode": "",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations/39"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations"
}
]
}
},
{
"id": 50,
"name": "Madrid",
"slug": "madrid",
"parent": 37,
"description": "",
"count": 3,
"barcode": "",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations/50"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations/37"
}
]
}
},
{
"id": 58,
"name": "Manchester",
"slug": "manchester",
"parent": 38,
"description": "",
"count": 0,
"barcode": "",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations/58"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations/38"
}
]
}
},
{
"id": 53,
"name": "Slovakia",
"slug": "slovakia",
"parent": 0,
"description": "",
"count": 0,
"barcode": "",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations/53"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations"
}
]
}
},
{
"id": 37,
"name": "Spain",
"slug": "spain",
"parent": 0,
"description": "",
"count": 7,
"barcode": "",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations/37"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations"
}
]
}
},
{
"id": 38,
"name": "United Kingdom",
"slug": "united-kingdom",
"parent": 0,
"description": "",
"count": 7,
"barcode": "UIOHOUIGHOUO",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations/38"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations"
}
]
}
},
{
"id": 49,
"name": "Valencia",
"slug": "valencia",
"parent": 37,
"description": "",
"count": 6,
"barcode": "",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations/49"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations/37"
}
]
}
}
]
Available parameters
| Parameter | Type | Description |
|---|---|---|
context |
string | Scope under which the request is made; determines fields present in response. Options: view and edit. Default is view. |
page |
integer | Current page of the collection. Default is 1. |
per_page |
integer | Maximum number of items to be returned in result set. Default is 10. |
search |
string | Limit results to those matching a string. |
exclude |
array | Ensure result set excludes specific ids. |
include |
array | Limit result set to specific ids. |
order |
string | Order sort attribute ascending or descending. Options: asc and desc. Default is asc. |
orderby |
string | Sort collection by resource attribute. Options: id, include, name, slug, term_group, description and count. Default is name. |
hide_empty |
boolean | Whether to hide resources not assigned to any products. Default is false. |
parent |
integer | Limit result set to resources assigned to a specific parent. |
product |
integer | Limit result set to resources assigned to a specific product. |
slug |
string | Limit result set to resources with a specific slug. |
barcode |
string | Limit result set to resources with a barcode. |
Update a product location
This API lets you make changes to a product location.
HTTP request
PUT
/wp-json/wc/v3/products/atum-locations/<id>
curl -X PUT https://example.com/wp-json/wc/v3/products/atum-locations/58 \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"description": "Manchester city."
}'
const data = {
description: "Manchester city."
};
WooCommerce.put("products/atum-locations/58", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'description' => 'Manchester city.'
];
print_r($woocommerce->put('products/atum-locations/58', $data));
?>
data = {
"description": "Manchester city."
}
print(wcapi.put("products/atum-locations/58", data).json())
data = {
description: "Manchester city."
}
woocommerce.put("products/atum-locations/58", data).parsed_response
JSON response example:
{
"id": 58,
"name": "Manchester",
"slug": "manchester",
"parent": 38,
"description": "Manchester city.",
"count": 0,
"barcode": "",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations/58"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations/38"
}
]
}
}
Delete a product location
This API helps you delete a product location.
HTTP request
DELETE
/wp-json/wc/v3/products/atum-locations/<id>
curl -X DELETE https://example.com/wp-json/wc/v3/products/atum-locations/58?force=true \
-u consumer_key:consumer_secret
WooCommerce.delete("products/atum-locations/58", {
force: true
})
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->delete('products/atum-locations/58', ['force' => true])); ?>
print(wcapi.delete("products/atum-locations/58", params={"force": True}).json())
woocommerce.delete("products/atum-locations/58", force: true).parsed_response
JSON response example:
{
"id": 58,
"name": "Manchester",
"slug": "manchester",
"parent": 38,
"description": "Manchester city.",
"count": 0,
"barcode": "",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations/58"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations/38"
}
]
}
}
Available parameters
| Parameter | Type | Description |
|---|---|---|
force |
string | Required to be true, as resource does not support trashing. |
Batch update product locations
This API helps you to batch create, update and delete multiple product locations.
HTTP request
POST
/wp-json/wc/v3/products/atum-locations/batch
curl -X POST https://example.com//wp-json/wc/v3/products/atum-locations/batch \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"create": [
{
"name": "London",
"parent": 38
},
{
"name": "Portugal"
}
],
"update": [
{
"id": 49,
"description": "Valencia city."
}
],
"delete": [
59
]
}'
const data = {
create: [
{
name: "London",
parent: 38
},
{
name: "Portugal"
}
],
update: [
{
id: 49,
description: "Valencia city."
}
],
delete: [
59
]
};
WooCommerce.post("products/atum-locations/batch", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'create' => [
[
'name' => 'London',
'parent' => 38
],
[
'name' => 'Portugal'
]
],
'update' => [
[
'id' => 49,
'description' => 'Valencia city.'
]
],
'delete' => [
59
]
];
print_r($woocommerce->post('products/atum-locations/batch', $data));
?>
data = {
"create": [
{
"name": "London",
"parent": 38
},
{
"name": "Portugal"
}
],
"update": [
{
"id": 49,
"description": "Valencia city."
}
],
"delete": [
59
]
}
print(wcapi.post("products/atum-locations/batch", data).json())
data = {
create: [
{
name: "London",
parent: 38
},
{
name: "Portugal"
}
],
update: [
{
id: 49,
description: "Valencia city."
}
],
delete: [
59
]
}
woocommerce.post("products/atum-locations/batch", data).parsed_response
JSON response example:
{
"create": [
{
"id": 60,
"name": "London",
"slug": "london",
"parent": 38,
"description": "",
"count": 0,
"barcode": "",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations/60"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations/38"
}
]
}
},
{
"id": 61,
"name": "Portugal",
"slug": "portugal",
"parent": 0,
"description": "",
"count": 0,
"barcode": "",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations/61"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations"
}
]
}
}
],
"update": [
{
"id": 49,
"name": "Valencia",
"slug": "valencia",
"parent": 37,
"description": "Valencia city.",
"count": 6,
"barcode": "",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations/49"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations/37"
}
]
}
}
],
"delete": [
{
"id": 59,
"name": "Manchester",
"slug": "manchester",
"parent": 38,
"description": "",
"count": 0,
"barcode": "",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations/59"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/products/atum-locations/38"
}
]
}
}
]
}
Purchase orders
ATUM
The purchase orders API allows you to create, view, update, and delete individual, or a batch, of purchase orders.
Purchase order properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Unique identifier for the resource. read-only |
status |
string | Purchase order status. Options: atum_pending, atum_ordered, atum_onthewayin, atum_receiving, atum_received and trash. |
currency |
string | Currency the purchase order was created with, in ISO format. Options: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTC, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, IRT, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PRB, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR and ZMW. Default is USD. |
date_created |
date-time | The date the purchase order was created, in the site's timezone. |
date_created_gmt |
date-time | The date the purchase order was created, as GMT. |
date_modified |
date-time | The date the purchase order was last modified, in the site's timezone. read-only |
date_modified_gmt |
date-time | The date the purchase order was last modified, as GMT. read-only |
discount_total |
string | Total discount amount for the purchase order. read-only |
discount_tax |
string | Total discount tax amount for the purchase order. read-only |
shipping_total |
string | Total shipping amount for the purchase order. read-only |
shipping_tax |
string | Total shipping tax amount for the purchase order. read-only |
cart_tax |
string | Sum of line item taxes only. read-only |
total |
string | Grand total. read-only |
total_tax |
string | Sum of all taxes. read-only |
prices_include_tax |
boolean | True the prices included tax during checkout. read-only |
date_completed |
date-time | The date the purchase order was completed, in the site's timezone. |
date_completed_gmt |
date-time | The date the purchase order was completed, as GMT. |
supplier |
integer | The supplier ID linked to the purchase order. |
multiple_suppliers |
boolean | Whether the multiple_suppliers switch is enabled or not. |
date_expected |
date-time | The date when the purchase order is expected at location, in the site's timezone. |
date_expected_gmt |
date-time | The date when the purchase order is expected at location, as GMT. |
line_items |
array | Line items data. See Purchase Order - Line items properties |
tax_lines |
array | Tax lines data. See Purchase Order - Tax lines properties read-only |
shipping_lines |
array | Shipping lines data. See Purchase Order - Shipping lines properties |
fee_lines |
array | Fee lines data. See Purchase Order - Fee lines properties |
meta_data |
array | Meta data. See Purchase Order - Meta data properties |
description |
string | The purchase order description. |
Purchase Order - Meta data properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Meta ID. read-only |
key |
string | Meta key. |
value |
string | Meta value. |
Purchase Order - Line items properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Item ID. read-only |
name |
string | Product name. |
product_id |
integer | Product ID. |
variation_id |
integer | Variation ID, if applicable. |
quantity |
integer | Quantity ordered. |
tax_class |
string | Slug of the tax class of product. |
subtotal |
string | Line subtotal (before discounts). |
subtotal_tax |
string | Line subtotal tax (before discounts). read-only |
total |
string | Line total (after discounts). |
total_tax |
string | Line total tax (after discounts). read-only |
taxes |
array | Line taxes. See Purchase Order - Taxes properties read-only |
stock_changed |
string | Whether the stock was already changed for this item. Options: yes and no. |
meta_data |
array | Meta data. See Purchase Order - Meta data properties |
sku |
string | Product SKU. read-only |
price |
string | Product price. read-only |
mi_inventories |
array | Multi-Inventory order items. See Purchase Order - MI Order Items properties Multi-Inventory |
bom_items |
array | BOM order items. See Purchase Order - BOM Order Items properties read-only Product Levels |
Purchase Order - Tax lines properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Item ID. read-only |
rate_code |
string | Tax rate code. read-only |
rate_id |
string | Tax rate ID. read-only |
label |
string | Tax rate label. read-only |
compound |
boolean | Show if is a compound tax rate. read-only |
tax_total |
string | Tax total (not including shipping taxes). read-only |
shipping_tax_total |
string | Shipping tax total. read-only |
meta_data |
array | Meta data. See Purchase Order - Meta data properties |
Purchase Order - Shipping lines properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Item ID. read-only |
method_title |
string | Shipping method name. |
method_id |
string | Shipping method ID. |
total |
string | Line total (after discounts). |
total_tax |
string | Line total tax (after discounts). read-only |
taxes |
array | Line taxes. See Purchase Order - Taxes properties read-only |
meta_data |
array | Meta data. See Purchase Order - Meta data properties |
Purchase Order - Fee lines properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Item ID. read-only |
name |
string | Fee name. |
tax_class |
string | Tax class of fee. |
tax_status |
string | Tax status of fee. Options: taxable and none. |
total |
string | Line total (after discounts). |
total_tax |
string | Line total tax (after discounts). read-only |
taxes |
array | Line taxes. See Purchase Order - Taxes properties read-only |
meta_data |
array | Meta data. See Purchase Order - Meta data properties |
Purchase Order - Taxes properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Item ID. read-only |
rate_code |
string | Tax rate code. read-only |
rate_id |
string | Tax rate ID. read-only |
label |
string | Tax rate label. read-only |
compound |
boolean | Show if is a compound tax rate. read-only |
tax_total |
string | Tax total (not including shipping taxes). read-only |
shipping_tax_total |
string | Shipping tax total. read-only |
meta_data |
array | Meta data. See Purchase Order - Meta data properties |
Purchase Order - MI Order Items properties Multi-Inventory
| Attribute | Type | Description |
|---|---|---|
id |
integer | The order item inventory ID. |
delete |
boolean | Set to true to delete the order item inventory with the specified inventory ID. write-only |
order_item_id |
integer | The order item ID linked to this order item inventory. |
inventory_id |
integer | The inventory ID linked to the order item. |
product_id |
integer | The product ID from where the inventory comes. |
qty |
number | The quantity of the specified inventory that is used on the order item. |
order_type |
integer | The type of order (WC Order = 1, Purchase Order = 2, Inventory Log = 3). |
subtotal |
number | Order item inventory's subtotal. |
total |
number | Order item inventory's total. |
refund_qty |
number | Order item inventory's refund quantity. |
refund_total |
number | Order item inventory's refund total. |
Purchase Order - BOM Order Items properties Product Levels
| Attribute | Type | Description |
|---|---|---|
id |
integer | The BOM order item ID. read-only |
bom_id |
integer | The BOM product ID associated to the BOM order item. read-only |
bom_type |
string | The BOM product type. Options: product_part and raw_material. read-only |
qty |
number | The quantity of the specified BOM that is used on the order item. read-only |
Create a purchase order
This API helps you to create a new purchase order.
HTTP request
POST
/wp-json/wc/v3/atum/purchase-orders
curl -X POST https://example.com/wp-json/wc/v3/atum/purchase-orders \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"supplier": 399,
"date_expected": "2019-11-11T11:26:41",
"description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
"status": "atum_ordered",
"line_items": [
{
"product_id": 93,
"quantity": 2,
"mi_inventories": [
{
"inventory_id": 152,
"qty": 1
},
{
"inventory_id": 126,
"qty": 1
}
]
},
{
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 112,
"qty": 1
}
]
}
]
}'
const data = {
supplier: 399,
date_expected: "2019-11-11T11:26:41",
description: "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
status: "atum_ordered",
line_items: [
{
product_id: 93,
quantity: 2,
mi_inventories: [
{
inventory_id: 152,
qty: 1
},
{
inventory_id: 126,
qty: 1
}
]
},
{
product_id: 22,
variation_id: 23,
quantity: 1,
mi_inventories: [
{
inventory_id: 112,
qty: 1
}
]
}
]
};
WooCommerce.post("atum/purchase-orders", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'supplier' => 399,
'date_expected' => '2019-11-11T11:26:41',
'description' => 'Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.',
'status' => 'atum_ordered',
'line_items' => [
[
'product_id' => 93,
'quantity' => 2,
'mi_inventories' => [
[
'inventory_id' => 152,
'qty' => 1
],
[
'inventory_id' => 126,
'qty' => 1
]
]
],
[
'product_id' => 22,
'variation_id' => 23,
'quantity' => 1,
'mi_inventories' => [
[
'inventory_id' => 112,
'qty' => 1
]
]
]
]
];
print_r($woocommerce->post('atum/purchase-orders', $data));
?>
data = {
"supplier": 399,
"date_expected": "2019-11-11T11:26:41",
"description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
"status": "atum_ordered",
"line_items": [
{
"product_id": 93,
"quantity": 2,
"mi_inventories": [
{
"inventory_id": 152,
"qty": 1
},
{
"inventory_id": 126,
"qty": 1
}
]
},
{
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 112,
"qty": 1
}
]
}
]
}
print(wcapi.post("atum/purchase-orders", data).json())
data = {
supplier: 399,
date_expected: "2019-11-11T11:26:41",
description: "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
status: "atum_ordered",
line_items: [
{
product_id: 93,
quantity: 2,
mi_inventories: [
{
inventory_id: 152,
qty: 1
},
{
inventory_id: 126,
qty: 1
}
]
},
{
product_id: 22,
variation_id: 23,
quantity: 1,
mi_inventories: [
{
inventory_id: 112,
qty: 1
}
]
}
]
}
woocommerce.post("atum/purchase-orders", data).parsed_response
JSON response example:
{
"id": 2156,
"status": "atum_ordered",
"currency": "EUR",
"prices_include_tax": false,
"date_created": "2019-11-12T09:37:12",
"date_modified": "2019-11-12T09:37:13",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "0.00",
"shipping_tax": "0.00",
"cart_tax": "1.20",
"total": "13.20",
"total_tax": "1.20",
"date_completed": "2019-11-12T09:37:14",
"line_items": [
{
"id": 337,
"name": "Woo Single #1",
"product_id": 93,
"variation_id": 0,
"quantity": 2,
"tax_class": "",
"subtotal": "6.00",
"subtotal_tax": "1.20",
"total": "6.00",
"total_tax": "1.20",
"taxes": [
{
"id": 1,
"total": "1.2",
"subtotal": "1.2"
}
],
"meta_data": [],
"sku": "Back Orders",
"price": 3,
"mi_inventories": [
{
"id": 201,
"inventory_id": 152,
"qty": 1,
"subtotal": 3,
"total": 0,
"refund_qty": 0,
"refund_total": 0
},
{
"id": 202,
"inventory_id": 126,
"qty": 1,
"subtotal": 3,
"total": 0,
"refund_qty": 0,
"refund_total": 0
},
{
"id": 203,
"inventory_id": 112,
"qty": 1,
"subtotal": 0,
"total": 0,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": []
},
{
"id": 338,
"name": "Ship Your Idea 2 - Black",
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"tax_class": "",
"subtotal": "0.00",
"subtotal_tax": "0.00",
"total": "0.00",
"total_tax": "0.00",
"taxes": [
{
"id": 1,
"total": "0",
"subtotal": "0"
}
],
"meta_data": {
"9": {
"id": "2872",
"key": "pa_color",
"value": "black"
}
},
"sku": "",
"price": 0,
"mi_inventories": [],
"bom_items": []
}
],
"tax_lines": [
{
"id": 339,
"rate_code": "GB-VAT-1",
"rate_id": 1,
"label": "VAT",
"compound": false,
"tax_total": "1.20",
"shipping_tax_total": "0.00",
"meta_data": []
}
],
"shipping_lines": [],
"fee_lines": [],
"description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
"supplier": "399",
"multiple_suppliers": false,
"date_expected": "2019-11-11T11:26:41",
"date_created_gmt": "2019-11-12T08:37:12",
"date_modified_gmt": "2019-11-12T09:37:13",
"date_completed_gmt": "2019-11-12T08:37:14",
"date_expected_gmt": "2019-11-11T10:26:41",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/2156"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders"
}
]
}
}
Retrieve a purchase order
This API lets you retrieve and view a specific purchase order.
HTTP request
GET
/wp-json/wc/v3/atum/purchase-orders/<id>
curl https://example.com/wp-json/wc/v3/atum/purchase-orders/1841 \
-u consumer_key:consumer_secret
WooCommerce.get("atum/purchase-orders/1841")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('atum/purchase-orders/1841')); ?>
print(wcapi.get("atum/purchase-orders/1841").json())
woocommerce.get("atum/purchase-orders/1841").parsed_response
JSON response example:
{
"id": 1841,
"status": "atum_receiving",
"currency": "EUR",
"prices_include_tax": false,
"date_created": "2019-10-04T09:35:00",
"date_modified": "2019-10-15T11:36:18",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "0.00",
"shipping_tax": "0.00",
"cart_tax": "5.20",
"total": "31.20",
"total_tax": "5.20",
"date_completed": "2019-11-12T09:42:58",
"line_items": [
{
"id": 313,
"name": "Woo Single #1",
"product_id": 93,
"variation_id": 0,
"quantity": 2,
"tax_class": "",
"subtotal": "6.00",
"subtotal_tax": "1.20",
"total": "6.00",
"total_tax": "1.20",
"taxes": [
{
"id": 1,
"total": "1.2",
"subtotal": "1.2"
}
],
"meta_data": {
"18": {
"id": "2703",
"key": "final",
"value": "version"
}
},
"sku": "Back Orders",
"price": 3,
"mi_inventories": [],
"bom_items": []
},
{
"id": 314,
"name": "Ship Your Idea 2 - Black",
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"tax_class": "",
"subtotal": "20.00",
"subtotal_tax": "4.00",
"total": "20.00",
"total_tax": "4.00",
"taxes": [
{
"id": 1,
"total": "4",
"subtotal": "4"
}
],
"meta_data": {
"9": {
"id": "2633",
"key": "pa_color",
"value": "black"
}
},
"sku": "",
"price": 20,
"mi_inventories": [],
"bom_items": []
}
],
"tax_lines": [
{
"id": 315,
"rate_code": "GB-VAT-1",
"rate_id": 1,
"label": "VAT",
"compound": false,
"tax_total": "5.20",
"shipping_tax_total": "0.00",
"meta_data": []
}
],
"shipping_lines": [],
"fee_lines": [],
"description": "",
"supplier": "399",
"multiple_suppliers": false,
"date_expected": "2019-10-05T08:00:00",
"date_created_gmt": "2019-10-04T09:35:00",
"date_modified_gmt": "2019-10-15T11:36:18",
"date_completed_gmt": "2019-11-12T08:42:58",
"date_expected_gmt": "2019-10-05T08:00:00",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/1841"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders"
}
]
}
}
Available parameters
| Parameter | Type | Description |
|---|---|---|
dp |
string | Number of decimal points to use in each resource. |
List all purchase orders
This API helps you to view all the purchase orders.
HTTP request
GET
/wp-json/wc/v3/atum/purchase-orders
curl https://example.com/wp-json/wc/v3/atum/purchase-orders \
-u consumer_key:consumer_secret
WooCommerce.get("atum/purchase-orders")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('atum/purchase-orders')); ?>
print(wcapi.get("atum/purchase-orders").json())
woocommerce.get("atum/purchase-orders").parsed_response
JSON response example:
[
{
"id": 1927,
"status": "atum_pending",
"currency": "EUR",
"prices_include_tax": false,
"date_created": "2019-10-24T10:16:12",
"date_modified": "2019-10-24T10:16:13",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "20.00",
"shipping_tax": "2.00",
"cart_tax": "4.00",
"total": "66.00",
"total_tax": "6.00",
"date_completed": "2019-11-12T09:45:21",
"line_items": [
{
"id": 316,
"name": "ABC 123 XPTO",
"product_id": 507,
"variation_id": 0,
"quantity": 5,
"tax_class": "",
"subtotal": "0.00",
"subtotal_tax": "0.00",
"total": "0.00",
"total_tax": "0.00",
"taxes": [
{
"id": 1,
"total": "0",
"subtotal": "0"
}
],
"meta_data": [],
"sku": "",
"price": 0,
"mi_inventories": [
{
"id": 189,
"inventory_id": 152,
"qty": 3,
"subtotal": 60,
"total": 60,
"refund_qty": 0,
"refund_total": 0
},
{
"id": 190,
"inventory_id": 126,
"qty": 2,
"subtotal": 20,
"total": 20,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": []
},
{
"id": 317,
"name": "Ship Your Idea 2 - Black",
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"tax_class": "",
"subtotal": "20.00",
"subtotal_tax": "4.00",
"total": "20.00",
"total_tax": "4.00",
"taxes": [
{
"id": 1,
"total": "4",
"subtotal": "4"
}
],
"meta_data": {
"9": {
"id": "2722",
"key": "pa_color",
"value": "black"
}
},
"sku": "",
"price": 20,
"mi_inventories": [],
"bom_items": []
}
],
"tax_lines": [
{
"id": 319,
"rate_code": "GB-VAT-1",
"rate_id": 1,
"label": "VAT",
"compound": false,
"tax_total": "4.00",
"shipping_tax_total": "2.00",
"meta_data": []
}
],
"shipping_lines": [
{
"id": 318,
"method_title": "Flat Rate",
"method_id": "flat_rate",
"total": "10.00",
"total_tax": "2.00",
"taxes": [
{
"id": 1,
"total": "2",
"subtotal": ""
}
],
"meta_data": []
}
],
"fee_lines": [],
"description": "",
"supplier": false,
"multiple_suppliers": true,
"date_expected": "2019-11-12T09:45:21",
"date_created_gmt": "2019-10-24T08:16:12",
"date_modified_gmt": "2019-10-24T10:16:13",
"date_completed_gmt": "2019-11-12T08:45:21",
"date_expected_gmt": "2019-11-12T08:45:21",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/1927"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders"
}
]
}
},
{
"id": 852,
"status": "atum_received",
"currency": "USD",
"prices_include_tax": false,
"date_created": "2019-04-30T18:35:00",
"date_modified": "2019-10-03T12:01:16",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "10.00",
"shipping_tax": "2.00",
"cart_tax": "2.00",
"total": "24.00",
"total_tax": "4.00",
"date_completed": "2019-11-12T09:45:21",
"line_items": [
{
"id": 283,
"name": "Variable Raw Material - Orange",
"product_id": 639,
"variation_id": 0,
"quantity": 1,
"tax_class": "",
"subtotal": "0.00",
"subtotal_tax": "0.00",
"total": "0.00",
"total_tax": "0.00",
"taxes": [
{
"id": 1,
"total": "0",
"subtotal": "0"
}
],
"meta_data": {
"10": {
"id": "2337",
"key": "pa_color",
"value": "orange"
}
},
"sku": "",
"price": 0,
"mi_inventories": [],
"bom_items": []
}
],
"tax_lines": [
{
"id": 287,
"rate_code": "GB-VAT-1",
"rate_id": 1,
"label": "VAT",
"compound": false,
"tax_total": "2.00",
"shipping_tax_total": "2.00",
"meta_data": []
}
],
"shipping_lines": [
{
"id": 286,
"method_title": "Flat rate",
"method_id": "flat_rate",
"total": "10.00",
"total_tax": "2.00",
"taxes": [
{
"id": 1,
"total": "2",
"subtotal": ""
}
],
"meta_data": []
}
],
"fee_lines": [
{
"id": 288,
"name": "Fee Edited",
"tax_class": "",
"tax_status": "taxable",
"total": "10.00",
"total_tax": "2.00",
"taxes": [
{
"id": 1,
"total": "2",
"subtotal": ""
}
],
"meta_data": []
}
],
"description": "",
"supplier": false,
"multiple_suppliers": true,
"date_expected": "2019-04-30T16:35:00",
"date_created_gmt": "2019-04-30T18:35:00",
"date_modified_gmt": "2019-10-03T12:01:16",
"date_completed_gmt": "2019-11-12T08:45:21",
"date_expected_gmt": "2019-04-30T16:35:00",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/852"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders"
}
]
}
},
{
"id": 851,
"status": "atum_received",
"currency": "EUR",
"prices_include_tax": false,
"date_created": "2019-04-30T17:40:00",
"date_modified": "2019-04-30T17:48:14",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "0.00",
"shipping_tax": "0.00",
"cart_tax": "0.00",
"total": "0.00",
"total_tax": "0.00",
"date_completed": "2019-11-12T09:45:21",
"line_items": [
{
"id": 282,
"name": "Variable Raw Material - Orange",
"product_id": 639,
"variation_id": 0,
"quantity": 2,
"tax_class": "",
"subtotal": "0.00",
"subtotal_tax": "0.00",
"total": "0.00",
"total_tax": "0.00",
"taxes": [],
"meta_data": {
"9": {
"id": "2288",
"key": "pa_color",
"value": "orange"
}
},
"sku": "",
"price": 0,
"mi_inventories": [],
"bom_items": []
}
],
"tax_lines": [],
"shipping_lines": [],
"fee_lines": [],
"description": "",
"supplier": false,
"multiple_suppliers": true,
"date_expected": "2019-04-30T15:47:00",
"date_created_gmt": "2019-04-30T17:40:00",
"date_modified_gmt": "2019-04-30T17:48:14",
"date_completed_gmt": "2019-11-12T08:45:21",
"date_expected_gmt": "2019-04-30T15:47:00",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/851"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders"
}
]
}
},
{
"id": 843,
"status": "atum_pending",
"currency": "EUR",
"prices_include_tax": false,
"date_created": "2019-04-30T13:17:00",
"date_modified": "2019-09-10T12:26:12",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "0.00",
"shipping_tax": "0.00",
"cart_tax": "0.00",
"total": "14.10",
"total_tax": "0.00",
"date_completed": "2019-11-12T09:45:22",
"line_items": [
{
"id": 278,
"name": "Product Part 1",
"product_id": 175,
"variation_id": 0,
"quantity": 1,
"tax_class": "zero-rate",
"subtotal": "12.00",
"subtotal_tax": "0.00",
"total": "12.00",
"total_tax": "0.00",
"taxes": [],
"meta_data": [],
"sku": "PART1",
"price": 12,
"mi_inventories": [],
"bom_items": []
},
{
"id": 279,
"name": "Variable Product Part 1 - Black",
"product_id": 512,
"variation_id": 513,
"quantity": 1,
"tax_class": "",
"subtotal": "2.10",
"subtotal_tax": "0.00",
"total": "2.10",
"total_tax": "0.00",
"taxes": [],
"meta_data": {
"9": {
"id": "2256",
"key": "pa_color",
"value": "black"
}
},
"sku": "VPART1",
"price": 2.1,
"mi_inventories": [],
"bom_items": []
}
],
"tax_lines": [],
"shipping_lines": [],
"fee_lines": [],
"description": "",
"supplier": false,
"multiple_suppliers": true,
"date_expected": "2019-04-30T11:20:00",
"date_created_gmt": "2019-04-30T13:17:00",
"date_modified_gmt": "2019-09-10T12:26:12",
"date_completed_gmt": "2019-11-12T08:45:22",
"date_expected_gmt": "2019-04-30T11:20:00",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/843"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders"
}
]
}
},
{
"id": 797,
"status": "atum_received",
"currency": "EUR",
"prices_include_tax": false,
"date_created": "2019-04-23T08:33:00",
"date_modified": "2019-05-27T09:16:09",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "0.00",
"shipping_tax": "0.00",
"cart_tax": "0.00",
"total": "4.00",
"total_tax": "0.00",
"date_completed": "2019-11-12T09:45:22",
"line_items": [
{
"id": 274,
"name": "ABC 123 XPTO",
"product_id": 507,
"variation_id": 0,
"quantity": 1,
"tax_class": "",
"subtotal": "4.00",
"subtotal_tax": "0.00",
"total": "4.00",
"total_tax": "0.00",
"taxes": [],
"meta_data": [],
"sku": "",
"price": 4,
"mi_inventories": [],
"bom_items": []
}
],
"tax_lines": [],
"shipping_lines": [],
"fee_lines": [],
"description": "",
"supplier": "426",
"multiple_suppliers": false,
"date_expected": "2019-06-28T00:00:00",
"date_created_gmt": "2019-04-23T08:33:00",
"date_modified_gmt": "2019-05-27T09:16:09",
"date_completed_gmt": "2019-11-12T08:45:22",
"date_expected_gmt": "2019-06-28T00:00:00",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/797"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders"
}
]
}
}
]
Available parameters
| Parameter | Type | Description |
|---|---|---|
context |
string | Scope under which the request is made; determines fields present in response. Options: view and edit. Default is view. |
page |
integer | Current page of the collection. Default is 1. |
per_page |
integer | Maximum number of items to be returned in result set. Default is 10. |
search |
string | Limit results to those matching a string. |
after |
string | Limit response to resources published after a given ISO8601 compliant date. |
before |
string | Limit response to resources published before a given ISO8601 compliant date. |
modified_after |
string | Limit response to resources modified after a given ISO8601 compliant date. |
modified_before |
string | Limit response to resources modified before a given ISO8601 compliant date. |
exclude |
array | Ensure result set excludes specific IDs. |
include |
array | Limit result set to specific ids. |
offset |
integer | Offset the result set by a specific number of items. |
order |
string | Order sort attribute ascending or descending. Options: asc and desc. Default is desc. |
orderby |
string | Sort collection by object attribute. Options: date, id, include, title and slug. Default is date. |
parent |
array | Limit result set to those of particular parent IDs. |
parent_exclude |
array | Limit result set to all items except those of a particular parent ID. |
status |
array | Limit result set to purchas orders assigned a specific status. Options: any, atum_pending, atum_ordered, atum_onthewayin, atum_receiving, atum_received and trash. Default is any. |
product |
integer | Limit result set to purchase orders assigned a specific product. |
dp |
integer | Number of decimal points to use in each resource. Default is 2. |
date_expected |
date-time | Limit result set to purchase orders expected at location on a given ISO8601 compliant date. |
supplier |
integer | Limit result set to purchase orders linked to the specified supplier ID. |
multiple_suppliers |
boolean | Limit result set to purchase orders depending on their multiple_suppliers switch status. |
Update a purchase order
This API lets you make changes to a purchase order.
HTTP Request
PUT
/wp-json/wc/v3/atum/purchase-orders/<id>
curl -X PUT https://example.com/wp-json/wc/v3/atum/purchase-orders/1927 \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"status": "atum_received"
}'
const data = {
status: "atum_received"
};
WooCommerce.put("atum/purchase-orders/1927", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'status' => 'atum_received'
];
print_r($woocommerce->put('atum/purchase-orders/1927', $data));
?>
data = {
"status": "atum_received"
}
print(wcapi.put("atum/purchase-orders/1927", data).json())
data = {
status: "atum_received"
}
woocommerce.put("atum/purchase-orders/1927", data).parsed_response
JSON response example:
{
"id": 1927,
"status": "atum_received",
"currency": "EUR",
"prices_include_tax": false,
"date_created": "2019-10-24T10:16:12",
"date_modified": "2019-11-12T10:15:56",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "20.00",
"shipping_tax": "2.00",
"cart_tax": "4.00",
"total": "66.00",
"total_tax": "6.00",
"date_completed": "2019-11-12T10:15:58",
"line_items": [
{
"id": 316,
"name": "ABC 123 XPTO",
"product_id": 507,
"variation_id": 0,
"quantity": 5,
"tax_class": "",
"subtotal": "0.00",
"subtotal_tax": "0.00",
"total": "0.00",
"total_tax": "0.00",
"taxes": [
{
"id": 1,
"total": "0",
"subtotal": "0"
}
],
"meta_data": [],
"sku": "",
"price": 0,
"mi_inventories": [
{
"id": 189,
"inventory_id": 152,
"qty": 3,
"subtotal": 60,
"total": 60,
"refund_qty": 0,
"refund_total": 0
},
{
"id": 190,
"inventory_id": 126,
"qty": 2,
"subtotal": 20,
"total": 20,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": [
{
"bom_id": 183,
"bom_type": "raw_material",
"qty": 10
},
{
"bom_id": 184,
"bom_type": "product_part",
"qty": 5
}
]
},
{
"id": 317,
"name": "Ship Your Idea 2 - Black",
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"tax_class": "",
"subtotal": "20.00",
"subtotal_tax": "4.00",
"total": "20.00",
"total_tax": "4.00",
"taxes": [
{
"id": 1,
"total": "4",
"subtotal": "4"
}
],
"meta_data": {
"9": {
"id": "2722",
"key": "pa_color",
"value": "black"
}
},
"sku": "",
"price": 20,
"mi_inventories": [],
"bom_items": []
}
],
"tax_lines": [
{
"id": 319,
"rate_code": "GB-VAT-1",
"rate_id": 1,
"label": "VAT",
"compound": false,
"tax_total": "4.00",
"shipping_tax_total": "2.00",
"meta_data": []
}
],
"shipping_lines": [
{
"id": 318,
"method_title": "Flat Rate",
"method_id": "flat_rate",
"total": "10.00",
"total_tax": "2.00",
"taxes": [
{
"id": 1,
"total": "2",
"subtotal": ""
}
],
"meta_data": []
}
],
"fee_lines": [],
"description": "",
"supplier": false,
"multiple_suppliers": true,
"date_expected": "2019-11-12T10:15:58",
"date_created_gmt": "2019-10-24T08:16:12",
"date_modified_gmt": "2019-11-12T10:15:56",
"date_completed_gmt": "2019-11-12T09:15:58",
"date_expected_gmt": "2019-11-12T09:15:58",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/1927"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders"
}
]
}
}
Delete a purchase order
This API helps you delete a purchase order.
HTTP request
DELETE
/wp-json/wc/v3/atum/purchase-orders/<id>
curl -X DELETE https://example.com/wp-json/wc/v3/atum/purchase-orders/2156?force=true \
-u consumer_key:consumer_secret
WooCommerce.delete("atum/purchase-orders/2156", {
force: true
})
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->delete('atum/purchase-orders/2156', ['force' => true])); ?>
print(wcapi.delete("atum/purchase-orders/2156", params={"force": True}).json())
woocommerce.delete("atum/purchase-orders/2156", force: true).parsed_response
JSON response example:
{
"id": 2156,
"status": "atum_ordered",
"currency": "EUR",
"prices_include_tax": false,
"date_created": "2019-11-12T09:37:12",
"date_modified": "2019-11-12T09:37:13",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "0.00",
"shipping_tax": "0.00",
"cart_tax": "1.20",
"total": "13.20",
"total_tax": "1.20",
"date_completed": "2019-11-12T10:18:43",
"line_items": [
{
"id": 337,
"name": "Woo Single #1",
"product_id": 93,
"variation_id": 0,
"quantity": 2,
"tax_class": "",
"subtotal": "6.00",
"subtotal_tax": "1.20",
"total": "6.00",
"total_tax": "1.20",
"taxes": [
{
"id": 1,
"total": "1.2",
"subtotal": "1.2"
}
],
"meta_data": [],
"sku": "Back Orders",
"price": 3,
"mi_inventories": [
{
"id": 201,
"inventory_id": 152,
"qty": 1,
"subtotal": 3,
"total": 0,
"refund_qty": 0,
"refund_total": 0
},
{
"id": 202,
"inventory_id": 126,
"qty": 1,
"subtotal": 3,
"total": 0,
"refund_qty": 0,
"refund_total": 0
},
{
"id": 203,
"inventory_id": 112,
"qty": 1,
"subtotal": 0,
"total": 0,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": []
},
{
"id": 338,
"name": "Ship Your Idea 2 - Black",
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"tax_class": "",
"subtotal": "0.00",
"subtotal_tax": "0.00",
"total": "0.00",
"total_tax": "0.00",
"taxes": [
{
"id": 1,
"total": "0",
"subtotal": "0"
}
],
"meta_data": {
"9": {
"id": "2872",
"key": "pa_color",
"value": "black"
}
},
"sku": "",
"price": 0,
"mi_inventories": [],
"bom_items": []
}
],
"tax_lines": [
{
"id": 339,
"rate_code": "GB-VAT-1",
"rate_id": 1,
"label": "VAT",
"compound": false,
"tax_total": "1.20",
"shipping_tax_total": "0.00",
"meta_data": []
}
],
"shipping_lines": [],
"fee_lines": [],
"description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
"supplier": "399",
"multiple_suppliers": false,
"date_expected": "2019-11-11T11:26:41",
"date_created_gmt": "2019-11-12T08:37:12",
"date_modified_gmt": "2019-11-12T09:37:13",
"date_completed_gmt": "2019-11-12T09:18:43",
"date_expected_gmt": "2019-11-11T10:26:41",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/2156"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders"
}
]
}
}
Available parameters
| Parameter | Type | Description |
|---|---|---|
force |
string | Use true whether to permanently delete the purchase order, Default is false. |
Batch update purchase orders
This API helps you to batch create, update and delete multiple purchase orders.
HTTP request
POST
/wp-json/wc/v3/atum/purchase-orders/batch
Example of Create, Update and Delete items in bulk:
curl -X POST https://example.com/wp-json/wc/v3/atum/purchase-orders/batch \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"create": [
{
"supplier": 399",
"status": "atum_onthewayin",
"line_items": [
{
"product_id": 79,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 13,
"qty": 1
}
]
},
{
"product_id": 93,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 14,
"qty": 1
}
]
},
{
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 58,
"qty": 1
}
]
}
],
"shipping_lines": [
{
"method_id": "flat_rate",
"method_title": "Flat Rate",
"total": 30
}
]
},
{
"multiple_suppliers": true,
"status": "atum_pending",
"line_items": [
{
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 59,
"qty": 1
}
]
},
{
"product_id": 22,
"variation_id": 24,
"quantity": 1
}
],
"shipping_lines": [
{
"method_id": "flat_rate",
"method_title": "Flat Rate",
"total": 20
}
]
}
],
"update": [
{
"id": 1841,
"date_expected": "2019-11-11T12:15:14"
}
],
"delete": [
1927
]
}'
const data = {
create: [
{
supplier: 399,
status: "atum_onthewayin",
line_items: [
{
product_id: 79,
quantity: 1,
mi_inventories: [
{
inventory_id: 13,
qty: 1
}
]
},
{
product_id: 93,
quantity: 1,
mi_inventories: [
{
inventory_id: 14,
qty: 1
}
]
},
{
product_id: 22,
variation_id: 23,
quantity: 1,
mi_inventories: [
{
inventory_id: 58,
qty: 1
}
]
}
],
shipping_lines: [
{
method_id: "flat_rate",
method_title: "Flat Rate",
total: 30
}
]
},
{
multiple_suppliers: true,
status: "atum_pending",
line_items: [
{
product_id: 22,
variation_id: 23,
quantity: 1,
mi_inventories: [
{
inventory_id: 59,
qty: 1
}
]
},
{
product_id: 22,
variation_id: 24,
quantity: 1
}
],
shipping_lines: [
{
method_id: "flat_rate",
method_title: "Flat Rate",
total: 20
}
]
}
],
update: [
{
id: 1841,
date_expected: "2019-11-11T12:15:14"
}
],
delete: [
1927
]
};
WooCommerce.post("atum/purchase-orders/batch", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'create' => [
[
'supplier' => 399,
'status' => 'atum_onthewayin',
'line_items' => [
[
'product_id' => 79,
'quantity' => 1,
'mi_inventories' => [
[
'inventory_id' => 13,
'qty' => 1
]
]
],
[
'product_id' => 93,
'quantity' => 1,
'mi_inventories' => [
[
'inventory_id' => 14,
'qty' => 1
]
]
],
[
'product_id' => 22,
'variation_id' => 23,
'quantity' => 1,
'mi_inventories' => [
[
'inventory_id' => 58,
'qty' => 1
]
]
]
],
'shipping_lines' => [
[
'method_id' => 'flat_rate',
'method_title' => 'Flat Rate',
'total' => 30
]
]
],
[
'multiple_suppliers' => true,
'status' => 'atum_pending',
'line_items' => [
[
'product_id' => 22,
'variation_id' => 23,
'quantity' => 1,
'mi_inventories' => [
[
'inventory_id' => 59,
'qty' => 1
]
]
],
[
'product_id' => 22,
'variation_id' => 24,
'quantity' => 1
]
],
'shipping_lines' => [
[
'method_id' => 'flat_rate',
'method_title' => 'Flat Rate',
'total' => 20
]
]
]
],
'update' => [
[
'id' => 1841,
'date_expected' => '2019-11-11T12:15:14'
]
],
'delete' => [
1927
]
];
print_r($woocommerce->post('atum/purchase-orders/batch', $data));
?>
data = {
"create": [
{
"supplier": 399,
"status": "atum_onthewayin",
"line_items": [
{
"product_id": 79,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 13,
"qty": 1
}
]
},
{
"product_id": 93,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 14,
"qty": 1
}
]
},
{
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 58,
"qty": 1
}
]
}
],
"shipping_lines": [
{
"method_id": "flat_rate",
"method_title": "Flat Rate",
"total": 30
}
]
},
{
"multiple_suppliers": true,
"status": "atum_pending",
"line_items": [
{
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"mi_inventories": [
{
"inventory_id": 59,
"qty": 1
}
]
},
{
"product_id": 22,
"variation_id": 24,
"quantity": 1
}
],
"shipping_lines": [
{
"method_id": "flat_rate",
"method_title": "Flat Rate",
"total": 20
}
]
}
],
"update": [
{
"id": 1841,
"date_expected": "2019-11-11T12:15:14"
}
],
"delete": [
1927
]
}
print(wcapi.post("atum/purchase-orders/batch", data).json())
data = {
create: [
{
supplier: 399,
status: "atum_onthewayin",
line_items: [
{
product_id: 79,
quantity: 1,
mi_inventories: [
{
inventory_id: 13,
qty: 1
}
]
},
{
product_id: 93,
quantity: 1,
mi_inventories: [
{
inventory_id: 14,
qty: 1
}
]
},
{
product_id: 22,
variation_id: 23,
quantity: 1,
mi_inventories: [
{
inventory_id: 58,
qty: 1
}
]
}
],
shipping_lines: [
{
method_id: "flat_rate",
method_title: "Flat Rate",
total: 30
}
]
},
{
multiple_suppliers: true,
status: "atum_pending",
line_items: [
{
product_id: 22,
variation_id: 23,
quantity: 1,
mi_inventories: [
{
inventory_id: 59,
qty: 1
}
]
},
{
product_id: 22,
variation_id: 24,
quantity: 1
}
],
shipping_lines: [
{
method_id: "flat_rate",
method_title: "Flat Rate",
total: 20
}
]
}
],
update: [
{
id: 1841,
date_expected: "2019-11-11T12:15:14"
}
],
delete: [
1927
]
}
woocommerce.post("atum/purchase-orders/batch", data).parsed_response
JSON response example:
{
"create": [
{
"id": 2157,
"status": "atum_onthewayin",
"currency": "EUR",
"prices_include_tax": false,
"date_created": "2019-11-12T10:24:07",
"date_modified": "2019-11-12T10:24:08",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "60.00",
"shipping_tax": "6.00",
"cart_tax": "3.60",
"total": "105.60",
"total_tax": "9.60",
"date_completed": "2019-11-12T10:24:08",
"line_items": [
{
"id": 340,
"name": "Woo Logo",
"product_id": 79,
"variation_id": 0,
"quantity": 1,
"tax_class": "",
"subtotal": "15.00",
"subtotal_tax": "3.00",
"total": "15.00",
"total_tax": "3.00",
"taxes": [
{
"id": 1,
"total": "3",
"subtotal": "3"
}
],
"meta_data": [],
"sku": "",
"price": 15,
"mi_inventories": [
{
"id": 204,
"inventory_id": 13,
"qty": 1,
"subtotal": 15,
"total": 0,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": []
},
{
"id": 341,
"name": "Woo Single #1",
"product_id": 93,
"variation_id": 0,
"quantity": 1,
"tax_class": "",
"subtotal": "3.00",
"subtotal_tax": "0.60",
"total": "3.00",
"total_tax": "0.60",
"taxes": [
{
"id": 1,
"total": "0.6",
"subtotal": "0.6"
}
],
"meta_data": [],
"sku": "Back Orders",
"price": 3,
"mi_inventories": [
{
"id": 205,
"inventory_id": 14,
"qty": 1,
"subtotal": 3,
"total": 0,
"refund_qty": 0,
"refund_total": 0
},
{
"id": 206,
"inventory_id": 58,
"qty": 1,
"subtotal": 9,
"total": 0,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": []
},
{
"id": 342,
"name": "Ship Your Idea 2 - Black",
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"tax_class": "",
"subtotal": "0.00",
"subtotal_tax": "0.00",
"total": "0.00",
"total_tax": "0.00",
"taxes": [
{
"id": 1,
"total": "0",
"subtotal": "0"
}
],
"meta_data": {
"9": {
"id": "2905",
"key": "pa_color",
"value": "black"
}
},
"sku": "",
"price": 0,
"mi_inventories": [],
"bom_items": []
}
],
"tax_lines": [
{
"id": 344,
"rate_code": "GB-VAT-1",
"rate_id": 1,
"label": "VAT",
"compound": false,
"tax_total": "3.60",
"shipping_tax_total": "6.00",
"meta_data": []
}
],
"shipping_lines": [
{
"id": 343,
"method_title": "Flat Rate",
"method_id": "flat_rate",
"total": "30.00",
"total_tax": "6.00",
"taxes": [
{
"id": 1,
"total": "6",
"subtotal": ""
}
],
"meta_data": []
}
],
"fee_lines": [],
"description": "",
"supplier": "399",
"multiple_suppliers": false,
"date_expected": "2019-11-12T10:24:08",
"date_created_gmt": "2019-11-12T09:24:07",
"date_modified_gmt": "2019-11-12T10:24:08",
"date_completed_gmt": "2019-11-12T09:24:08",
"date_expected_gmt": "2019-11-12T09:24:08",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/2157"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders"
}
]
}
},
{
"id": 2158,
"status": "atum_pending",
"currency": "EUR",
"prices_include_tax": false,
"date_created": "2019-11-12T10:24:09",
"date_modified": "2019-11-12T10:24:11",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "40.00",
"shipping_tax": "4.00",
"cart_tax": "4.00",
"total": "88.00",
"total_tax": "8.00",
"date_completed": "2019-11-12T10:24:11",
"line_items": [
{
"id": 345,
"name": "Ship Your Idea 2 - Black",
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"tax_class": "",
"subtotal": "0.00",
"subtotal_tax": "0.00",
"total": "0.00",
"total_tax": "0.00",
"taxes": [
{
"id": 1,
"total": "0",
"subtotal": "0"
}
],
"meta_data": {
"9": {
"id": "2924",
"key": "pa_color",
"value": "black"
}
},
"sku": "",
"price": 0,
"mi_inventories": [],
"bom_items": []
},
{
"id": 346,
"name": "Ship Your Idea 2 - Green",
"product_id": 22,
"variation_id": 24,
"quantity": 1,
"tax_class": "",
"subtotal": "20.00",
"subtotal_tax": "4.00",
"total": "20.00",
"total_tax": "4.00",
"taxes": [
{
"id": 1,
"total": "4",
"subtotal": "4"
}
],
"meta_data": {
"9": {
"id": "2934",
"key": "pa_color",
"value": "green"
}
},
"sku": "",
"price": 20,
"mi_inventories": [],
"bom_items": []
}
],
"tax_lines": [
{
"id": 348,
"rate_code": "GB-VAT-1",
"rate_id": 1,
"label": "VAT",
"compound": false,
"tax_total": "4.00",
"shipping_tax_total": "4.00",
"meta_data": []
}
],
"shipping_lines": [
{
"id": 347,
"method_title": "Flat Rate",
"method_id": "flat_rate",
"total": "20.00",
"total_tax": "4.00",
"taxes": [
{
"id": 1,
"total": "4",
"subtotal": ""
}
],
"meta_data": []
}
],
"fee_lines": [],
"description": "",
"supplier": false,
"multiple_suppliers": true,
"date_expected": "2019-11-12T10:24:12",
"date_created_gmt": "2019-11-12T09:24:09",
"date_modified_gmt": "2019-11-12T10:24:11",
"date_completed_gmt": "2019-11-12T09:24:11",
"date_expected_gmt": "2019-11-12T09:24:12",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/2158"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders"
}
]
}
}
],
"update": [
{
"id": 1841,
"status": "atum_receiving",
"currency": "EUR",
"prices_include_tax": false,
"date_created": "2019-10-04T09:35:00",
"date_modified": "2019-11-12T10:24:12",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "0.00",
"shipping_tax": "0.00",
"cart_tax": "5.20",
"total": "31.20",
"total_tax": "5.20",
"date_completed": "2019-11-12T10:24:12",
"line_items": [
{
"id": 313,
"name": "Woo Single #1",
"product_id": 93,
"variation_id": 0,
"quantity": 2,
"tax_class": "",
"subtotal": "6.00",
"subtotal_tax": "1.20",
"total": "6.00",
"total_tax": "1.20",
"taxes": [
{
"id": 1,
"total": "1.2",
"subtotal": "1.2"
}
],
"meta_data": {
"18": {
"id": "2703",
"key": "final",
"value": "version"
}
},
"sku": "Back Orders",
"price": 3,
"mi_inventories": [],
"bom_items": []
},
{
"id": 314,
"name": "Ship Your Idea 2 - Black",
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"tax_class": "",
"subtotal": "20.00",
"subtotal_tax": "4.00",
"total": "20.00",
"total_tax": "4.00",
"taxes": [
{
"id": 1,
"total": "4",
"subtotal": "4"
}
],
"meta_data": {
"9": {
"id": "2633",
"key": "pa_color",
"value": "black"
}
},
"sku": "",
"price": 20,
"mi_inventories": [],
"bom_items": []
}
],
"tax_lines": [
{
"id": 315,
"rate_code": "GB-VAT-1",
"rate_id": 1,
"label": "VAT",
"compound": false,
"tax_total": "5.20",
"shipping_tax_total": "0.00",
"meta_data": []
}
],
"shipping_lines": [],
"fee_lines": [],
"description": "",
"supplier": "399",
"multiple_suppliers": false,
"date_expected": "2019-11-11T12:15:14",
"date_created_gmt": "2019-10-04T09:35:00",
"date_modified_gmt": "2019-11-12T10:24:12",
"date_completed_gmt": "2019-11-12T09:24:12",
"date_expected_gmt": "2019-11-11T11:15:14",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/1841"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders"
}
]
}
}
],
"delete": [
{
"id": 1927,
"status": "atum_received",
"currency": "EUR",
"prices_include_tax": false,
"date_created": "2019-10-24T10:16:12",
"date_modified": "2019-11-12T10:15:56",
"discount_total": "0.00",
"discount_tax": "0.00",
"shipping_total": "20.00",
"shipping_tax": "2.00",
"cart_tax": "4.00",
"total": "66.00",
"total_tax": "6.00",
"date_completed": "2019-11-12T10:24:12",
"line_items": [
{
"id": 316,
"name": "ABC 123 XPTO",
"product_id": 507,
"variation_id": 0,
"quantity": 5,
"tax_class": "",
"subtotal": "0.00",
"subtotal_tax": "0.00",
"total": "0.00",
"total_tax": "0.00",
"taxes": [
{
"id": 1,
"total": "0",
"subtotal": "0"
}
],
"meta_data": [],
"sku": "",
"price": 0,
"mi_inventories": [
{
"id": 189,
"inventory_id": 152,
"qty": 3,
"subtotal": 60,
"total": 60,
"refund_qty": 0,
"refund_total": 0
},
{
"id": 190,
"inventory_id": 126,
"qty": 2,
"subtotal": 20,
"total": 20,
"refund_qty": 0,
"refund_total": 0
}
],
"bom_items": [
{
"bom_id": 183,
"bom_type": "raw_material",
"qty": 10
},
{
"bom_id": 184,
"bom_type": "product_part",
"qty": 5
}
]
},
{
"id": 317,
"name": "Ship Your Idea 2 - Black",
"product_id": 22,
"variation_id": 23,
"quantity": 1,
"tax_class": "",
"subtotal": "20.00",
"subtotal_tax": "4.00",
"total": "20.00",
"total_tax": "4.00",
"taxes": [
{
"id": 1,
"total": "4",
"subtotal": "4"
}
],
"meta_data": {
"9": {
"id": "2722",
"key": "pa_color",
"value": "black"
}
},
"sku": "",
"price": 20,
"mi_inventories": [],
"bom_items": []
}
],
"tax_lines": [
{
"id": 319,
"rate_code": "GB-VAT-1",
"rate_id": 1,
"label": "VAT",
"compound": false,
"tax_total": "4.00",
"shipping_tax_total": "2.00",
"meta_data": []
}
],
"shipping_lines": [
{
"id": 318,
"method_title": "Flat Rate",
"method_id": "flat_rate",
"total": "10.00",
"total_tax": "2.00",
"taxes": [
{
"id": 1,
"total": "2",
"subtotal": ""
}
],
"meta_data": []
}
],
"fee_lines": [],
"description": "",
"supplier": false,
"multiple_suppliers": true,
"date_expected": "2019-11-12T10:24:12",
"date_created_gmt": "2019-10-24T08:16:12",
"date_modified_gmt": "2019-11-12T10:15:56",
"date_completed_gmt": "2019-11-12T09:24:12",
"date_expected_gmt": "2019-11-12T09:24:12",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/1927"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders"
}
]
}
}
]
}
Purchase order notes
ATUM
The purchase order notes API allows you to create, view, and delete individual purchase order notes.
Purchase order notes are added by administrators and programmatically to store data about a purchase order, or its events.
Purchase order note properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Unique identifier for the resource. read-only |
author |
string | Purchase order note author. read-only |
date_created |
date-time | The date the purchase order note was created, in the site's timezone. read-only |
date_created_gmt |
date-time | The date the purchase order note was created, as GMT. read-only |
note |
string | Purchase order note content. mandatory |
added_by_user |
boolean | If true, this note will be attributed to the current user. If false, the note will be attributed to the system. Default is false. |
Create a purchase order note
This API helps you to create a new note for a purchase order.
HTTP request
POST
/wp-json/wc/v3/atum/purchase-orders/<id>/notes
curl -X POST https://example.com/wp-json/wc/v3/atum/purchase-orders/713/notes \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"note": "FROM REST ok!!!"
}'
const data = {
note: "FROM REST ok!!!"
};
WooCommerce.post("atum/purchase-orders/852/notes", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'note' => 'FROM REST ok!!!'
];
print_r($woocommerce->post('atum/purchase-orders/852/notes', $data));
?>
data = {
"note": "FROM REST ok!!!"
}
print(wcapi.post("atum/purchase-orders/852/notes", data).json())
data = {
note: "FROM REST ok!!!"
}
woocommerce.post("atum/purchase-orders/852/notes", data).parsed_response
JSON response example:
{
"id": 4226,
"author": "John Doe",
"date_created": "2019-11-12T10:40:51",
"date_created_gmt": "2019-11-12T09:40:51",
"note": "FROM REST ok!!!",
"added_by_user": true,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/852/notes/4226"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/852/notes"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/852"
}
]
}
}
Retrieve a purchase order note
This API lets you retrieve and view a specific note from a purchase order.
HTTP request
GET
/wp-json/wc/v3/atum/purchase-orders/<id>/notes/<note_id>
curl https://example.com/wp-json/wc/v3/atum/purchase-orders/852/notes/4226 \
-u consumer_key:consumer_secret
WooCommerce.get("atum/purchase-orders/852/notes/4226")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('atum/purchase-orders/852/notes/4226')); ?>
print(wcapi.get("atum/purchase-orders/852/notes/4226").json())
woocommerce.get("atum/purchase-orders/852/notes/4226").parsed_response
JSON response example:
{
"id": 4226,
"author": "John Doe",
"date_created": "2019-11-12T10:40:51",
"date_created_gmt": "2019-11-12T09:40:51",
"note": "FROM REST ok!!!",
"added_by_user": true,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/852/notes/4226"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/852/notes"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/852"
}
]
}
}
List all purchase order notes
This API helps you to view all the notes from a purchase order.
HTTP request
GET
/wp-json/wc/v3/atum/purchase-orders/<id>/notes
curl https://example.com/wp-json/wc/v3/atum/purchase-orders/852/notes \
-u consumer_key:consumer_secret
WooCommerce.get("atum/purchase-orders/852/notes")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('atum/purchase-orders/852/notes')); ?>
print(wcapi.get("atum/purchase-orders/852/notes").json())
woocommerce.get("atum/purchase-orders/852/notes").parsed_response
JSON response example:
[
{
"id": 4226,
"author": "John Doe",
"date_created": "2019-11-12T10:40:51",
"date_created_gmt": "2019-11-12T09:40:51",
"note": "FROM REST ok!!!",
"added_by_user": true,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/852/notes/4226"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/852/notes"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/852"
}
]
}
},
{
"id": 3770,
"author": "ATUM",
"date_created": "2019-10-03T12:01:16",
"date_created_gmt": "2019-10-03T10:01:16",
"note": "Order status changed from Receiving to Received.",
"added_by_user": false,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/852/notes/3770"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/852/notes"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/852"
}
]
}
},
{
"id": 3752,
"author": "ATUM",
"date_created": "2019-10-02T13:36:44",
"date_created_gmt": "2019-10-02T11:36:44",
"note": "Order status changed from Pending to Receiving.",
"added_by_user": false,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/852/notes/3752"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/852/notes"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/852"
}
]
}
},
{
"id": 1027,
"author": "ATUM",
"date_created": "2019-04-30T18:59:56",
"date_created_gmt": "2019-04-30T16:59:56",
"note": "Item 642 stock decreased from 23 to 22.",
"added_by_user": false,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/852/notes/1027"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/852/notes"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/852"
}
]
}
},
{
"id": 1028,
"author": "ATUM",
"date_created": "2019-04-30T18:59:56",
"date_created_gmt": "2019-04-30T16:59:56",
"note": "Order status changed from Received to Pending.",
"added_by_user": false,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/852/notes/1028"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/852/notes"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/852"
}
]
}
},
{
"id": 1025,
"author": "ATUM",
"date_created": "2019-04-30T18:56:54",
"date_created_gmt": "2019-04-30T16:56:54",
"note": "Item 642 stock increased from 22 to 23.",
"added_by_user": false,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/852/notes/1025"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/852/notes"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/852"
}
]
}
}
]
Available parameters
| Parameter | Type | Description |
|---|---|---|
type |
string | Limit result to user or system notes. Options: any, user and system. Default is any. |
Delete a purchase order note
This API helps you delete a purchase order note.
HTTP request
DELETE
/wp-json/wc/v3/atum/purchase-orders/<id>/notes/<note_id>
curl -X DELETE https://example.com/wp-json/wc/v3/atum/purchase-orders/852/notes/4226?force=true \
-u consumer_key:consumer_secret
WooCommerce.delete("atum/purchase-orders/852/notes/4226", {
force: true
})
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->delete('atum/purchase-orders/852/notes/4226', ['force' => true])); ?>
print(wcapi.delete("atum/purchase-orders/852/notes/4226", params={"force": True}).json())
woocommerce.delete("atum/purchase-orders/852/notes/4226", force: true).parsed_response
JSON response example:
{
"id": 4226,
"author": "John Doe",
"date_created": "2019-11-12T10:40:51",
"date_created_gmt": "2019-11-12T09:40:51",
"note": "FROM REST ok!!!",
"added_by_user": true,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/852/notes/4226"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/852/notes"
}
],
"up": [
{
"href": "https://example.com/wp-json/wc/v3/atum/purchase-orders/852"
}
]
}
}
Available parameters
| Parameter | Type | Description |
|---|---|---|
force |
string | Required to be true, as resource does not support trashing. |
Settings
ATUM
The settings API allows you to view all groups of ATUM settings available.
Setting group properties
| Attribute | Type | Description |
|---|---|---|
id |
string | A unique identifier that can be used to link settings together. read-only |
label |
string | A human readable label for the setting used in interfaces. read-only |
description |
string | A human readable description for the setting used in interfaces. read-only |
sections |
string | IDs for settings sections within groups. read-only |
List all settings groups
This API helps you to view all the settings groups.
HTTP request
GET
/wp-json/wc/v3/atum/settings
curl https://example.com/wp-json/wc/v3/atum/settings \
-u consumer_key:consumer_secret
WooCommerce.get("atum/settings")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('atum/settings')); ?>
print(wcapi.get("atum/settings").json())
woocommerce.get("atum/settings").parsed_response
JSON response example:
[
{
"id": "general",
"label": "General",
"description": "",
"sections": {
"general": "General Options"
},
"_links": {
"options": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general"
}
]
}
},
{
"id": "store_details",
"label": "Store Details",
"description": "",
"sections": {
"company": "Company info",
"shipping": "Shipping info"
},
"_links": {
"options": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/store_details"
}
]
}
},
{
"id": "module_manager",
"label": "Modules",
"description": "",
"sections": {
"module_manager": "Module Manager"
},
"_links": {
"options": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/module_manager"
}
]
}
},
{
"id": "visual_settings",
"label": "Visual Settings",
"description": "",
"sections": {
"color_mode": "Color Mode",
"color_scheme": "Color Scheme"
},
"_links": {
"options": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/visual_settings"
}
]
}
},
{
"id": "multi_inventory",
"label": "Multi-Inventory",
"description": "",
"sections": {
"multi_inventory": "Multi-Inventory Options",
"geoprompt": "Geo Prompt Popup"
},
"_links": {
"options": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/multi_inventory"
}
]
}
},
{
"id": "product_levels",
"label": "Product Levels",
"description": "",
"sections": {
"product_levels": "General Options",
"manufacturing_central": "Manufacturing Central Options"
},
"_links": {
"options": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/product_levels"
}
]
}
},
{
"id": "tools",
"label": "Tools",
"description": "",
"sections": {
"tools": "ATUM Tools"
},
"_links": {
"options": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/tools"
}
]
}
}
]
Setting options
ATUM
Setting option properties
| Attribute | Type | Description |
|---|---|---|
id |
string | A unique identifier for the setting. read-only |
group_id |
string | An identifier for the group this setting belongs to. read-only |
section |
string | An identifier for the group section this setting belongs to. read-only |
name |
string | A human readable name for the setting used in interfaces. read-only |
desc |
string | A human readable description for the setting used in interfaces. read-only |
value |
mixed | Setting value. |
default |
mixed | Default value for the setting. read-only |
type |
string | Type of setting. Options: text, number, color, switcher, textarea, select, html, wc_country, button_group, script_runner and theme_selector. read-only |
options |
object | Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons. read-only |
dependency |
object | The dependency config array for any depedent settings. read-only |
confirm_msg |
string | The message that is shown when a confirmation is needed when changing a setting. read-only |
Retrieve a setting option
This API lets you retrieve and view a specific setting option.
HTTP request
GET
/wp-json/wc/v3/atum/settings/<group_id>/<id>
curl https://example.com/wp-json/wc/v3/atum/settings/general/show_totals \
-u consumer_key:consumer_secret
WooCommerce.get("atum/settings/general/show_totals")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('atum/settings/general/show_totals')); ?>
print(wcapi.get("atum/settings/general/show_totals").json())
woocommerce.get("atum/settings/general/show_totals").parsed_response
JSON response example:
{
"id": "show_totals",
"group": "general",
"section": "general",
"name": "Show Totals Row",
"desc": "When enabled, ATUM will display new row at the bottom of Stock Central. You will be able to preview page column totals of essential stock counters.",
"type": "switcher",
"default": "yes",
"value": "yes",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general/show_totals"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general"
}
]
}
}
List all setting options
This API helps you to view all the setting options.
HTTP request
GET
/wp-json/wc/v3/atum/settings/<id>
curl https://example.com/wp-json/wc/v3/atum/settings/general \
-u consumer_key:consumer_secret
WooCommerce.get("atum/settings/general")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('atum/settings/general')); ?>
print(wcapi.get("atum/settings/general").json())
woocommerce.get("atum/settings/general").parsed_response
JSON response example:
[
{
"id": "enable_ajax_filter",
"group": "general",
"section": "general",
"name": "Enable Filter Autosearch",
"desc": "When enabled, the manual search button disappears. Disable this function if you don't use or find the automatic search feature helpful.",
"type": "switcher",
"default": "yes",
"value": "no",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general/enable_ajax_filter"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general"
}
]
}
},
{
"id": "enhanced_suppliers_filter",
"group": "general",
"section": "general",
"name": "Enhanced Suppliers' Filter",
"desc": "When enabled, the List Tables Suppliers' filter will be replaced by an advanced search box. Recommended for sites with many suppliers.",
"type": "switcher",
"default": "no",
"value": "yes",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general/enhanced_suppliers_filter"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general"
}
]
}
},
{
"id": "show_totals",
"group": "general",
"section": "general",
"name": "Show Totals Row",
"desc": "When enabled, ATUM will display new row at the bottom of Stock Central. You will be able to preview page column totals of essential stock counters.",
"type": "switcher",
"default": "yes",
"value": "yes",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general/show_totals"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general"
}
]
}
},
{
"id": "enable_admin_bar_menu",
"group": "general",
"section": "general",
"name": "Enable Admin Bar Menu",
"desc": "When enabled, the ATUM menu will be accessible through the WP admin bar.",
"type": "switcher",
"default": "yes",
"value": "yes",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general/enable_admin_bar_menu"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general"
}
]
}
},
{
"id": "show_variations_stock",
"group": "general",
"section": "general",
"name": "Override 'Out of stock' Status",
"desc": "When enabled, the variations' stock status will be displayed in WooCommerce products' list for variable products. This overrides the 'Out of stock' status displayed by WooCommerce, when stock is managed at product level for variable products.",
"type": "switcher",
"default": "yes",
"value": "yes",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general/show_variations_stock"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general"
}
]
}
},
{
"id": "out_stock_threshold",
"group": "general",
"section": "general",
"name": "Out of Stock Threshold per product",
"desc": "Activate the switch to disable WooCommerce's global out of stock threshold setting and enable ATUM's out of stock threshold per product. All products will inherit the WooCommerce's global value by default (if set).<br><br>\n\t\t\t Deactivate the switch to disable ATUM's out of stock threshold per product and re-enable the WooCommerce's global out of stock threshold. All your saved individual values will remain untouched in your database and ready for a future use, in case you decide to return to the individual control.<br><br>\n\t\t\t\t We have a specific tool to clear all the individual out of stock threshold values in the 'Tools' section.",
"type": "switcher",
"default": "no",
"confirm_msg": "This will clear all the Out Stock Threshold values that have been set in all products",
"value": "yes",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general/out_stock_threshold"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general"
}
]
}
},
{
"id": "unmanaged_counters",
"group": "general",
"section": "general",
"name": "Unmanaged Product Counters",
"desc": "Add 'In Stock', 'Out of Stock' and 'Back Ordered' counters and views for Unmanaged by WooCommerce Products in all ATUM list tables. This option will also add these products to the Dashboard Stock Control Widget. Please note that enabling this option can affect the performance in stores with a large number of products.",
"type": "switcher",
"default": "no",
"value": "no",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general/unmanaged_counters"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general"
}
]
}
},
{
"id": "stock_quantity_decimals",
"group": "general",
"section": "general",
"name": "Decimals in Stock Quantity",
"desc": "Enter the number of decimal places your shop needs in stock quantity fields. Set 0 to keep or 1 and higher to override the default WooCommerce NO decimal setting.",
"type": "number",
"default": 0,
"options": {
"min": 0,
"max": 4
},
"value": 0,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general/stock_quantity_decimals"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general"
}
]
}
},
{
"id": "stock_quantity_step",
"group": "general",
"section": "general",
"name": "Stock change arrows behaviour",
"desc": "Tell WooCommerce, how much to increase/decrease the stock value with each arrow click. Example: If set to ‘0.5’; the stock will change from value ‘5’ to value ‘5.5’ when pressing the UP arrow. Pressing the DOWN arrow will reduce the stock to ‘4.5’.",
"type": "number",
"default": 0,
"options": {
"min": 0,
"max": 4,
"step": 0.01
},
"value": 0,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general/stock_quantity_step"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general"
}
]
}
},
{
"id": "sales_last_ndays",
"group": "general",
"section": "general",
"name": "Show sales in the last selected days",
"desc": "Enter the number of days to calculate the number of sales in that period in one Stock Central column.",
"type": "number",
"default": 14,
"options": {
"min": 1,
"max": 31
},
"value": 14,
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general/sales_last_ndays"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general"
}
]
}
},
{
"id": "delete_data",
"group": "general",
"section": "general",
"name": "Delete Data When Uninstalling",
"desc": "Enable before uninstalling to remove all the data stored by ATUM in your database. Not recommended if you plan to reinstall ATUM in the future.",
"type": "switcher",
"default": "no",
"value": "no",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general/delete_data"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general"
}
]
}
}
]
Update a setting option
This API lets you make changes to a setting option.
HTTP request
PUT
/wp-json/wc/v3/atum/settings/<group_id>/<id>
curl -X PUT https://example.com/wp-json/wc/v3/atum/settings/general/show_totals \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"value": "no"
}'
const data = {
value: "no"
};
WooCommerce.put("atum/settings/general/show_totals", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'value' => 'no'
];
print_r($woocommerce->put('atum/settings/general/show_totals', $data));
?>
data = {
"value": "no"
}
print(wcapi.put("atum/settings/general/show_totals", data).json())
data = {
value: "no"
}
woocommerce.put("atum/settings/general/show_totals", data).parsed_response
JSON response example:
{
"id": "show_totals",
"group": "general",
"section": "general",
"name": "Show Totals Row",
"desc": "When enabled, ATUM will display new row at the bottom of Stock Central. You will be able to preview page column totals of essential stock counters.",
"type": "switcher",
"default": "yes",
"value": "no",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general/show_totals"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general"
}
]
}
}
Batch update setting options
This API helps you to batch update multiple setting options.
HTTP request
POST
/wp-json/wc/v3/atum/settings/<id>/batch
curl -X POST https://example.com/wp-json/wc/v3/atum/settings/general/batch \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"update": [
{
"id": "enable_ajax_filter",
"value": "yes"
},
{
"id": "enhanced_suppliers_filter",
"value": "yes"
},
{
"id": "show_totals",
"value": "yes"
}
]
}'
const data = {
update: [
{
id: "enable_ajax_filter",
value: "yes"
},
{
id: "enhanced_suppliers_filter",
value: "yes"
},
{
id: "show_totals",
value: "yes"
}
]
};
WooCommerce.post("atum/settings/general/batch", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'update' => [
[
'id' => 'enable_ajax_filter',
'value' => 'yes'
],
[
'id' => 'enhanced_suppliers_filter',
'value' => 'yes'
],
[
'id' => 'show_totals',
'value' => 'yes'
]
]
];
print_r($woocommerce->post('atum/settings/general/batch', $data));
?>
data = {
"update": [
{
"id": "enable_ajax_filter",
"value": "yes"
},
{
"id": "enhanced_suppliers_filter",
"value": "yes"
},
{
"id": "show_totals",
"value": "yes"
}
]
}
print(wcapi.post("atum/settings/general/batch", data).json())
data = {
update: [
{
id: "enable_ajax_filter",
value: "yes"
},
{
id: "enhanced_suppliers_filter",
value: "yes"
},
{
id: "show_totals",
value: "yes"
}
]
}
woocommerce.post("atum/settings/general/batch", data).parsed_response
JSON response example:
{
"update": [
{
"id": "enable_ajax_filter",
"group": "general",
"section": "general",
"name": "Enable Filter Autosearch",
"desc": "When enabled, the manual search button disappears. Disable this function if you don't use or find the automatic search feature helpful.",
"type": "switcher",
"default": "yes",
"value": "yes",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general/enable_ajax_filter"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general"
}
]
}
},
{
"id": "enhanced_suppliers_filter",
"group": "general",
"section": "general",
"name": "Enhanced Suppliers' Filter",
"desc": "When enabled, the List Tables Suppliers' filter will be replaced by an advanced search box. Recommended for sites with many suppliers.",
"type": "switcher",
"default": "no",
"value": "yes",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general/enhanced_suppliers_filter"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general"
}
]
}
},
{
"id": "show_totals",
"group": "general",
"section": "general",
"name": "Show Totals Row",
"desc": "When enabled, ATUM will display new row at the bottom of Stock Central. You will be able to preview page column totals of essential stock counters.",
"type": "switcher",
"default": "yes",
"value": "yes",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general/show_totals"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/settings/general"
}
]
}
}
]
}
Suppliers
ATUM
The suppliers API allows you to create, view, update, and delete individual, or a batch, of suppliers.
Supplier properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Unique identifier for the resource. read-only |
name |
string | Supplier name. |
slug |
string | Supplier slug. |
permalink |
string | Supplier URL. read-only |
date_created |
date-time | The date the supplier was created, in the site's timezone. read-only |
date_created_gmt |
date-time | The date the supplier was created, as GMT. read-only |
date_modified |
date-time | The date the supplier was last modified, in the site's timezone. read-only |
date_modified_gmt |
date-time | The date the supplier was last modified, as GMT. read-only |
status |
string | Supplier status (post status). Options: draft, pending, private and publish. Default is publish. |
code |
string | Supplier code. |
tax_number |
string | Supplier tax/VAT number. |
phone |
string | Supplier phone number. |
fax |
string | Supplier fax number. |
website |
string | Supplier website. |
ordering_url |
string | Supplier ordering URL. |
general_email |
string | Supplier general email. |
ordering_email |
string | Supplier ordering email. |
description |
string | Supplier description. |
currency |
string | Supplier currency, in ISO format. Options: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTC, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, IRT, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PRB, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR and ZMW. |
address |
string | Supplier address. |
city |
string | Supplier city. |
country |
string | Supplier country ISO 3166 code. See ISO 3166 Codes (Countries) for more details. |
state |
string | Supplier state. |
zip_code |
string | Supplier ZIP code. |
assigned_to |
integer | The user ID that this supplier is assigned to. |
location |
string | The location used in Purchase Orders assigned to this supplier. |
images |
object | Supplier featured image. See Supplier - Image properties |
meta_data |
array | Meta data. See Supplier - Meta data properties |
Supplier - Image properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Image ID. |
date_created |
date-time | The date the image was created, in the site's timezone. read-only |
date_created_gmt |
date-time | The date the image was created, as GMT. read-only |
date_modified |
date-time | The date the image was last modified, in the site's timezone. read-only |
date_modified_gmt |
date-time | The date the image was last modified, as GMT. read-only |
src |
string | Image URL. |
name |
string | Image name. |
alt |
string | Image alternative text. |
Supplier - Meta data properties
| Attribute | Type | Description |
|---|---|---|
id |
integer | Meta ID. read-only |
key |
string | Meta key. |
value |
string | Meta value. |
Create a supplier
This API helps you to create a new supplier.
HTTP request
POST
/wp-json/wc/v3/atum/suppliers
curl -X POST https://example.com/wp-json/wc/v3/atum/suppliers \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"name": "Supplier REST",
"code": "4675763",
"tax_number": "ES7667858Y",
"phone": "+3412345678",
"website": "https://example.com",
"currency": "EUR",
"address": "5th Avenue",
"city": "London",
"country": "GB",
"assigned_to": 1,
"location": "United Kingdom"
}'
const data = {
name: "Supplier REST",
code: "4675763",
tax_number: "ES7667858Y",
phone: "+3412345678",
website: "https://example.com",
currency: "EUR",
address: "5th Avenue",
city: "London",
country: "GB",
assigned_to: 1,
location: "United Kingdom"
};
WooCommerce.post("atum/suppliers", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'name' => 'Supplier REST',
'code' => "4675763",
'tax_number' => 'ES7667858Y',
'phone' => '+3412345678',
'website' => 'https://example.com',
'currency' => 'EUR',
'address' => '5th Avenue',
'city' => 'London',
'country' => 'GB',
'assigned_to' => 1,
'location' => 'United Kingdom'
];
print_r($woocommerce->post('atum/suppliers', $data));
?>
data = {
"name": "Supplier REST",
"code": "4675763",
"tax_number": "ES7667858Y",
"phone": "+3412345678",
"website": "https://example.com",
"currency": "EUR",
"address": "5th Avenue",
"city": "London",
"country": "GB",
"assigned_to": 1,
"location": "United Kingdom"
}
print(wcapi.post("atum/suppliers", data).json())
data = {
name: "Supplier REST",
code: "4675763",
tax_number: "ES7667858Y",
phone: "+3412345678",
website: "https://example.com",
currency: "EUR",
address: "5th Avenue",
city: "London",
country: "GB",
assigned_to: 1,
location: "United Kingdom"
}
woocommerce.post("atum/suppliers", data).parsed_response
JSON response example:
{
"id": 2159,
"name": "Supplier REST",
"slug": "supplier-rest",
"permalink": "https://example.com/?post_type=atum_supplier&p=2159",
"date_created": "2019-11-12T12:34:38",
"date_created_gmt": "2019-11-12T11:34:38",
"date_modified": "2019-11-12T12:34:38",
"date_modified_gmt": "2019-11-12T11:34:38",
"status": "publish",
"code": "4675763",
"tax_number": "ES7667858Y",
"phone": "+3412345678",
"website": "https://example.com",
"currency": "EUR",
"address": "5th Avenue",
"city": "London",
"country": "GB",
"assigned_to": "1",
"location": "United Kingdom",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/suppliers/2159"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/suppliers"
}
]
}
}
Retrieve a supplier
This API lets you retrieve and view a specific supplier by ID.
HTTP request
GET
/wp-json/wc/v3/atum/suppliers/<id>
curl https://example.com/wp-json/wc/v3/atum/suppliers/399 \
-u consumer_key:consumer_secret
WooCommerce.get("atum/suppliers/399")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('atum/suppliers/399')); ?>
print(wcapi.get("atum/suppliers/399").json())
woocommerce.get("atum/suppliers/399").parsed_response
JSON response example:
{
"id": 399,
"name": "Supplier 2",
"slug": "supplier-2",
"permalink": "https://example.com/?post_type=atum_supplier&p=399",
"date_created": "2017-10-10T16:39:31",
"date_created_gmt": "2017-10-10T15:39:31",
"date_modified": "2017-10-10T17:39:58",
"date_modified_gmt": "2017-10-10T16:39:58",
"status": "publish",
"code": "56498498",
"tax_number": "959+58548",
"phone": "98498498",
"currency": "EUR",
"country": "ES",
"state": "Valencia",
"assigned_to": "1",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/suppliers/399"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/suppliers"
}
]
}
}
List all suppliers
This API helps you to view all the suppliers.
HTTP request
GET
/wp-json/wc/v3/atum/suppliers
curl https://example.com/wp-json/wc/v3/atum/suppliers \
-u consumer_key:consumer_secret
WooCommerce.get("atum/suppliers")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('atum/suppliers')); ?>
print(wcapi.get("atum/suppliers").json())
woocommerce.get("atum/suppliers").parsed_response
JSON response example:
[
{
"id": 2159,
"name": "Supplier REST",
"slug": "supplier-rest",
"permalink": "https://example.com/?post_type=atum_supplier&p=2159",
"date_created": "2019-11-12T12:34:38",
"date_created_gmt": "2019-11-12T11:34:38",
"date_modified": "2019-11-12T12:34:38",
"date_modified_gmt": "2019-11-12T11:34:38",
"status": "publish",
"code": "4675763",
"tax_number": "ES7667858Y",
"phone": "+3412345678",
"website": "https://example.com",
"currency": "EUR",
"address": "5th Avenue",
"city": "London",
"country": "GB",
"assigned_to": "1",
"location": "United Kingdom",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/suppliers/2159"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/suppliers"
}
]
}
},
{
"id": 545,
"name": "BOM Supplier",
"slug": "bom-supplier",
"permalink": "https://example.com/?post_type=atum_supplier&p=545",
"date_created": "2018-06-11T07:14:58",
"date_created_gmt": "2018-06-11T06:14:58",
"date_modified": "2019-09-27T12:30:30",
"date_modified_gmt": "2019-09-27T10:30:30",
"status": "publish",
"code": "854984984",
"tax_number": "85489489",
"currency": "BTC",
"country": "CU",
"assigned_to": "1",
"image": {
"id": 69,
"date_created": "2013-06-07T13:22:05",
"date_created_gmt": "2013-06-07T11:22:05",
"date_modified": "2013-06-07T13:22:05",
"date_modified_gmt": "2013-06-07T11:22:05",
"src": "https://example.com/wp-content/uploads/2013/06/Poster_1_flat.jpg",
"name": "Poster_1_flat",
"alt": ""
},
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/suppliers/545"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/suppliers"
}
]
}
},
{
"id": 426,
"name": "New Supplier",
"slug": "newsupplier",
"permalink": "https://example.com/?post_type=atum_supplier&p=426",
"date_created": "2018-01-10T15:58:10",
"date_created_gmt": "2018-01-10T15:58:10",
"date_modified": "2018-01-17T07:56:11",
"date_modified_gmt": "2018-01-17T07:56:11",
"status": "publish",
"code": "AAABBB",
"tax_number": "1234567",
"phone": "321654",
"currency": "ARS",
"address": "Elm Street, 19",
"city": "Madrid",
"country": "ES",
"state": "Madrid",
"zip_code": "24001",
"assigned_to": "1",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/suppliers/426"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/suppliers"
}
]
}
},
{
"id": 399,
"name": "Supplier 2",
"slug": "supplier-2",
"permalink": "https://example.com/?post_type=atum_supplier&p=399",
"date_created": "2017-10-10T16:39:31",
"date_created_gmt": "2017-10-10T15:39:31",
"date_modified": "2017-10-10T17:39:58",
"date_modified_gmt": "2017-10-10T16:39:58",
"status": "publish",
"code": "56498498",
"tax_number": "959+58548",
"phone": "98498498",
"currency": "EUR",
"country": "ES",
"state": "Valencia",
"assigned_to": "1",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/suppliers/399"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/suppliers"
}
]
}
}
]
Available parameters
| Parameter | Type | Description |
|---|---|---|
context |
string | Scope under which the request is made; determines fields present in response. Options: view and edit. Default is view. |
page |
integer | Current page of the collection. Default is 1. |
per_page |
integer | Maximum number of items to be returned in result set. Default is 10. |
search |
string | Limit results to those matching a string. |
after |
string | Limit response to resources published after a given ISO8601 compliant date. |
before |
string | Limit response to resources published before a given ISO8601 compliant date. |
modified_after |
string | Limit response to resources modified after a given ISO8601 compliant date. |
modified_before |
string | Limit response to resources modified before a given ISO8601 compliant date. |
exclude |
array | Ensure result set excludes specific IDs. |
include |
array | Limit result set to specific ids. |
offset |
integer | Offset the result set by a specific number of items. |
order |
string | Order sort attribute ascending or descending. Options: asc and desc. Default is desc. |
orderby |
string | Sort collection by object attribute. Options: date, id, include, title and slug. Default is date. |
slug |
string | Limit result set to suppliers with a specific slug. |
status |
string | Limit result set to suppliers assigned a specific status. Options: any, draft, pending, private and publish. Default is any. |
currency |
string | Limit result set to suppliers using the specified currency code, in ISO format. Options: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTC, BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, IRT, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PRB, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR and ZMW. |
country |
string | Limit result set to suppliers from the specified ISO 3166 country code. See ISO 3166 Codes (Countries) for more details. |
assigned_to |
integer | Limit result set to suppliers assigned to the specified user ID. |
product |
integer | Limit result set to suppliers assigned to the specific product ID. |
Update a supplier
This API lets you make changes to a supplier.
HTTP request
PUT
/wp-json/wc/v3/atum/suppliers/<id>
curl -X PUT https://example.com/wp-json/wc/v3/atum/suppliers/399 \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"country": "ES",
"location": "Spain"
}'
const data = {
country: "ES",
location: "Spain"
};
WooCommerce.put("atum/suppliers/399", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'country' => 'ES',
'location' => 'Spain'
];
print_r($woocommerce->put('atum/suppliers/399', $data));
?>
data = {
"country": "ES",
"location": "Spain"
}
print(wcapi.put("atum/suppliers/399", data).json())
data = {
country: "ES",
location: "Spain"
}
woocommerce.put("atum/suppliers/399", data).parsed_response
JSON response example:
{
"id": 399,
"name": "Supplier 2",
"slug": "supplier-2",
"permalink": "https://example.com/?post_type=atum_supplier&p=399",
"date_created": "2017-10-10T16:39:31",
"date_created_gmt": "2017-10-10T15:39:31",
"date_modified": "2019-11-12T13:26:49",
"date_modified_gmt": "2019-11-12T12:26:49",
"status": "publish",
"code": "56498498",
"tax_number": "959+58548",
"phone": "98498498",
"currency": "EUR",
"country": "ES",
"state": "Valencia",
"assigned_to": "1",
"location": "Spain",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/suppliers/399"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/suppliers"
}
]
}
}
Delete a supplier
This API helps you delete a supplier.
HTTP request
DELETE
/wp-json/wc/v3/atum/suppliers/<id>
curl -X DELETE https://example.com/wp-json/wc/v3/atum/suppliers/2159?force=true \
-u consumer_key:consumer_secret
WooCommerce.delete("atum/suppliers/2159", {
force: true
})
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->delete('atum/suppliers/2159', ['force' => true])); ?>
print(wcapi.delete("atum/suppliers/2159", params={"force": True}).json())
woocommerce.delete("atum/suppliers/2159", force: true).parsed_response
JSON response example:
{
"id": 2159,
"name": "Supplier REST",
"slug": "supplier-rest",
"permalink": "https://example.com/?post_type=atum_supplier&p=2159",
"date_created": "2019-11-12T12:34:38",
"date_created_gmt": "2019-11-12T11:34:38",
"date_modified": "2019-11-12T12:34:38",
"date_modified_gmt": "2019-11-12T11:34:38",
"status": "publish",
"code": "4675763",
"tax_number": "ES7667858Y",
"phone": "+3412345678",
"website": "https://example.com",
"currency": "EUR",
"address": "5th Avenue",
"city": "London",
"country": "GB",
"assigned_to": "1",
"location": "United Kingdom",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/suppliers/2159"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/suppliers"
}
]
}
}
Available parameters
| Parameter | Type | Description |
|---|---|---|
force |
string | Use true whether to permanently delete the supplier, Default is false. |
Batch update suppliers
This API helps you to batch create, update and delete multiple suppliers.
HTTP request
POST
/wp-json/wc/v3/atum/suppliers/batch
curl -X POST https://example.com/wp-json/wc/v3/atum/suppliers/batch \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json" \
-d '{
"create": [
{
"name": "TEST Batch Supplier",
"tax_number": "GB87263874"
},
{
"name": "TEST Batch Supplier 2",
"address": "Saints Street, 500"
}
],
"update": [
{
"id": 426,
"code": "ABC123"
}
],
"delete": [
1817
]
}'
const data = {
create: [
{
name: "TEST Batch Supplier",
tax_number: "GB87263874"
},
{
name: "TEST Batch Supplier 2",
address: "Saints Street, 500"
}
],
update: [
{
id: 426,
code: "ABC123"
}
],
delete: [
1817
]
};
WooCommerce.post("atum/suppliers/batch", data)
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
$data = [
'create' => [
[
'name' => 'TEST Batch Supplier',
'tax_number' => 'GB87263874'
],
[
'name' => 'TEST Batch Supplier 2',
'address' => 'Saints Street, 500'
]
],
'update' => [
[
'id' => 426,
'code' => 'ABC123'
]
],
'delete' => [
1817
]
];
print_r($woocommerce->post('atum/suppliers/batch', $data));
?>
data = {
"create": [
{
"name": "TEST Batch Supplier",
"tax_number": "GB87263874"
},
{
"name": "TEST Batch Supplier 2",
"address": "Saints Street, 500"
}
],
"update": [
{
"id": 426,
"code": "ABC123"
}
],
"delete": [
1817
]
}
print(wcapi.post("atum/suppliers/batch", data).json())
data = {
create: [
{
name: "TEST Batch Supplier",
tax_number: "GB87263874"
},
{
name: "TEST Batch Supplier 2",
address: "Saints Street, 500"
}
],
update: [
{
id: 426,
code: "ABC123"
}
],
delete: [
1817
]
}
woocommerce.post("atum/suppliers/batch", data).parsed_response
JSON response example:
{
"create": [
{
"id": 2161,
"name": "TEST Batch Supplier",
"slug": "test-batch-supplier",
"permalink": "https://example.com/?post_type=atum_supplier&p=2161",
"date_created": "2019-11-12T13:37:55",
"date_created_gmt": "2019-11-12T12:37:55",
"date_modified": "2019-11-12T13:37:55",
"date_modified_gmt": "2019-11-12T12:37:55",
"status": "publish",
"tax_number": "GB87263874",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/suppliers/2161"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/suppliers"
}
]
}
},
{
"id": 2162,
"name": "TEST Batch Supplier 2",
"slug": "test-batch-supplier-2",
"permalink": "https://example.com/?post_type=atum_supplier&p=2162",
"date_created": "2019-11-12T13:37:55",
"date_created_gmt": "2019-11-12T12:37:55",
"date_modified": "2019-11-12T13:37:55",
"date_modified_gmt": "2019-11-12T12:37:55",
"status": "publish",
"address": "Saints Street, 500",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/suppliers/2162"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/suppliers"
}
]
}
}
],
"update": [
{
"id": 426,
"name": "New Supplier",
"slug": "newsupplier",
"permalink": "https://example.com/?post_type=atum_supplier&p=426",
"date_created": "2018-01-10T15:58:10",
"date_created_gmt": "2018-01-10T15:58:10",
"date_modified": "2019-11-12T13:37:55",
"date_modified_gmt": "2019-11-12T12:37:55",
"status": "publish",
"code": "ABC123",
"tax_number": "1234567",
"phone": "321654",
"currency": "ARS",
"address": "Elm Street, 19",
"city": "Madrid",
"country": "ES",
"state": "Madrid",
"zip_code": "24001",
"assigned_to": "1",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/suppliers/426"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/suppliers"
}
]
}
}
],
"delete": [
{
"id": 1817,
"name": "REST old supplier",
"slug": "rest-old-supplier",
"permalink": "https://example.com/?post_type=atum_supplier&p=1817",
"date_created": "2019-09-30T13:55:51",
"date_created_gmt": "2019-09-30T11:55:51",
"date_modified": "2019-09-30T13:55:51",
"date_modified_gmt": "2019-09-30T11:55:51",
"status": "publish",
"code": "675675GQA",
"currency": "EUR",
"country": "ES",
"assigned_to": "1",
"_links": {
"self": [
{
"href": "https://example.com/wp-json/wc/v3/atum/suppliers/1817"
}
],
"collection": [
{
"href": "https://example.com/wp-json/wc/v3/atum/suppliers"
}
]
}
}
]
}
Tools
ATUM
The ATUM tools API allows you to view and run tools.
Tool properties
| Attribute | Type | Description |
|---|---|---|
id |
string | A unique identifier for the tool. read-only |
name |
string | Tool nice name. read-only |
description |
string | Tool description. read-only |
config |
object | If the tool needs config in order to work. |
success |
boolean | Did the tool run successfully? read-only write-only |
message |
string | Tool return message. read-only write-only |
Retrieve a tool
This API lets you retrieve and view a specific tool by ID.
HTTP request
GET
/wp-json/wc/v3/atum/tools/<id>
curl https://example.com/wp-json/wc/v3/atum/tools/enable-atum-control \
-u consumer_key:consumer_secret
WooCommerce.get("atum/tools/enable-atum-control")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('atum/tools/enable-atum-control')); ?>
print(wcapi.get("atum/tools/enable-atum-control").json())
woocommerce.get("atum/tools/enable-atum-control").parsed_response
JSON response example:
{
"id": "enable-atum-control",
"name": "Enable ATUM Stock Control",
"description": "Enable the ATUM's stock control option for all the products at once.",
"_links": {
"item": [
{
"embeddable": true,
"href": "https://example.com/wp-json/wc/v3/atum/tools/enable-atum-control"
}
]
}
}
List all tools
This API helps you to view all the available ATUM tools.
HTTP request
GET
/wp-json/wc/v3/atum/tools
curl https://example.com/wp-json/wc/v3/atum/tools \
-u consumer_key:consumer_secret
WooCommerce.get("atum/tools")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php print_r($woocommerce->get('atum/tools')); ?>
print(wcapi.get("atum/tools").json())
woocommerce.get("atum/tools").parsed_response
JSON response example:
[
{
"id": "enable-manage-stock",
"name": "Enable WC's Manage Stock",
"description": "Enable the WooCommerce's manage stock at product level for all the products at once.",
"_links": {
"item": [
{
"embeddable": true,
"href": "https://example.com/wp-json/wc/v3/atum/tools/enable-manage-stock"
}
]
}
},
{
"id": "disable-manage-stock",
"name": "Disable WC's Manage Stock",
"description": "Disable the WooCommerce's manage stock at product level for all the products at once.",
"_links": {
"item": [
{
"embeddable": true,
"href": "https://example.com/wp-json/wc/v3/atum/tools/disable-manage-stock"
}
]
}
},
{
"id": "enable-atum-control",
"name": "Enable ATUM Stock Control",
"description": "Enable the ATUM's stock control option for all the products at once.",
"_links": {
"item": [
{
"embeddable": true,
"href": "https://example.com/wp-json/wc/v3/atum/tools/enable-atum-control"
}
]
}
},
{
"id": "disable-atum-control",
"name": "Disable ATUM Stock Control",
"description": "Disable the ATUM's stock control option for all the products at once.",
"_links": {
"item": [
{
"embeddable": true,
"href": "https://example.com/wp-json/wc/v3/atum/tools/disable-atum-control"
}
]
}
},
{
"id": "clear-out-stock-threshold",
"name": "Clear Out of Stock Threshold",
"description": "Clear all previously saved Out of Stock Threshold values.",
"_links": {
"item": [
{
"embeddable": true,
"href": "https://example.com/wp-json/wc/v3/atum/tools/clear-out-stock-threshold"
}
]
}
},
{
"id": "sync_calculated_stock",
"name": "Sync WooCommerce stock with calculated stock",
"description": "Sync all the associated BOM products' stock with their current calculated stock.",
"_links": {
"item": [
{
"embeddable": true,
"href": "https://example.com/wp-json/wc/v3/atum/tools/sync_calculated_stock"
}
]
}
}
]
Run a tool
This API lets you run an ATUM tool.
HTTP request
PUT
/wp-json/wc/v3/atum/tools/<id>
curl -X PUT https://example.com/wp-json/wc/v3/atum/tools/enable-manage-stock \
-u consumer_key:consumer_secret \
-H "Content-Type: application/json"
WooCommerce.put("atum/tools/enable-manage-stock")
.then((response) => {
console.log(response.data);
})
.catch((error) => {
console.log(error.response.data);
});
<?php
print_r($woocommerce->put('atum/tools/enable-manage-stock'));
?>
print(wcapi.put("atum/tools/enable-manage-stock").json())
woocommerce.put("atum/tools/enable-manage-stock").parsed_response
JSON response example:
{
"id": "enable-manage-stock",
"name": "Enable WC's Manage Stock",
"description": "Enable the WooCommerce's manage stock at product level for all the products at once.",
"success": true,
"message": "All your products were updated successfully",
"_links": {
"item": [
{
"embeddable": true,
"href": "https://example.com/wp-json/wc/v3/atum/tools/enable-manage-stock"
}
]
}
}