Diese Dokumentation führt Sie durch die Einrichtung einer Verbindung zwischen dem schlaf•de Marktplatz und Ihrer Infrastruktur – Shop oder Warenwirtschaftssystem. Die hier dokumentierte REST-API ermöglicht es Nutzern, Anbieterdaten durch Anfragen im JSON-Format zu verwalten.
Die schlafplatz.schlaf.de – API verwendet HTTP Basic Auth und erfordert einen Benutzernamen und ein Passwort für den Zugriff.
Der Benutzername sollte der Kontoname oder die E-Mail-Adresse des Anbieters sein.
Um das API-Passwort zu erhalten, stellen Sie bitte eine Anfrage über dieses Formular
Mit der Produkt-API können Sie einzelne Produkte oder einen Stapel davon erstellen, anzeigen, aktualisieren und löschen.
| Parameter | Type | Description |
|---|---|---|
id |
integer | Unique identifier for the resource. READ-ONLY |
name |
string | Product name Required – Only Create. |
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 and variable. Default is simple. |
status |
string | Product status (post status). Options: draft, pending, publish. It depends on vendor publishing admin settings |
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. |
in_stock |
boolean | Controls whether or not the product is listed as “in stock” or “out of stock” on the frontend. Default is true. |
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 |
string | 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 Required – Only create |
tags |
array | List of tags. See Product – Tags 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 |
| Attribute | Type | Description |
|---|---|---|
id |
string | File MD5 hash. READ-ONLY |
name |
string | File name. |
file |
string | File URL. |
| Attribute | Type | Description |
|---|---|---|
length |
string | Product length. |
width |
string | Product width. |
height |
string | Product height. |
| Attribute | Type | Description |
|---|---|---|
id |
integer | Category ID. |
name |
string | Category name. READ-ONLY |
slug |
string | Category slug. READ-ONLY |
| Attribute | Type | Description |
|---|---|---|
id |
integer | Tag ID. |
name |
string | Tag name. READ-ONLY |
slug |
string | Tag slug. READ-ONLY |
| 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. |
position |
integer | Image position. 0 means that the image is featured. |
| 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. |
| Attribute | Type | Description |
|---|---|---|
id |
integer | Attribute ID. |
name |
string | Attribute name. |
option |
string | Selected attribute term name. |
| Attribute | Type | Description |
|---|---|---|
id |
integer | Meta ID. READ-ONLY |
key |
string | Meta key. |
value |
string | Meta value. |
This endpoint helps you to create a new product.
POST https://teststage.schlaf.de/wp-json/dokan/v1/products/
Accept all parameters for a product propertiest
This API lets you retrieve and view a specific product by ID.
GET https://teststage.schlaf.de/wp-json/dokan/v1/products/<id>
This endpoint retrieves all Product for authorized vendor.
GET https://teststage.schlaf.de/wp-json/dokan/v1/products/
| Parameter | Type | Description |
|---|---|---|
per_page |
integer | Maximum number of items to be returned in result set. Default is 10. |
page |
integer | Current page of the collection. Default is 1 |
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. |
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 and variable. |
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. |
in_stock |
boolean | Limit result set to products in stock or out of stock. |
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. |
This API lets you make changes to a product.
PUT https://teststage.schlaf.de/wp-json/dokan/v1/products/<id>
This endpoint helps you to delete a product.
DELETE https://teststage.schlaf.de/wp-json/dokan/v1/products/<id>
This endpoint helps you to get products summary of a vendor.
GET https://teststage.schlaf.de/wp-json/dokan/v1/products/summary
The product variations API allows you to create, view, update, and delete individual, or a batch, of product variations.
| 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_modified |
date-time | The date the variation was last modified, in the site’s timezone. 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 |
visible |
boolean | Define if the attribute is visible on the “Additional information” tab in the product’s page. Default is true. |
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. |
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. |
in_stock |
boolean | Controls whether or not the variation is listed as “in stock” or “out of stock” on the frontend. Default is true. |
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. |
shipping_class |
string | Shipping class slug. |
shipping_class_id |
string | Shipping class ID. read-only |
image |
object | Variation image data. |
attributes |
array | List of attributes. |
menu_order |
integer | Menu order, used to custom sort products. |
meta_data |
array | Meta data. |
| Attribute | Type | Description |
|---|---|---|
id |
string | File MD5 hash. READ-ONLY |
name |
string | File name. |
file |
string | File URL. |
| Attribute | Type | Description |
|---|---|---|
length |
string | Product length. |
width |
string | Product width. |
height |
string | Product height. |
| 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. |
position |
integer | Image position. 0 means that the image is featured. |
| Attribute | Type | Description |
|---|---|---|
id |
integer | Attribute ID. |
name |
string | Attribute name. |
option |
string | Selected attribute term name. |
| Attribute | Type | Description |
|---|---|---|
id |
integer | Meta ID. READ-ONLY |
key |
string | Meta key. |
value |
string | Meta value. |
This API helps you to create a new product variation.
POST https://teststage.schlaf.de/wp-json/dokan/v1/products/<product_id>/variations
This API lets you retrieve and view a specific product variation by ID.
GET https://teststage.schlaf.de/wp-json/dokan/v1/products/<product_id>/variations/<id>
This API helps you to view all the product variations.
GET https://teststage.schlaf.de/wp-json/dokan/v1/products/<product_id>/variations
| 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. |
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 and variable. |
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. |
in_stock |
boolean | Limit result set to products in stock or out of stock. |
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. |
This API lets you make changes to a product variation.
PUT https://teststage.schlaf.de/wp-json/dokan/v1/products/<product_id>/variations/<id>
This API helps you delete a product variation.
DELETE https://teststage.schlaf.de/wp-json/dokan/v1/products/<product_id>/variations/<id>
This API helps you get all attributes.
GET https://teststage.schlaf.de/wp-json/dokan/v1/products/attributes
This API helps you get single attribute.
GET https://teststage.schlaf.de/wp-json/dokan/v1/products/attributes/<id>
This API helps you create an attribute.
POST https://teststage.schlaf.de/wp-json/dokan/v1/products/attributes
This API helps you to update attributes.
PUT https://teststage.schlaf.de/wp-json/dokan/v1/products/attributes/<id>
This API helps you delete single attributes.
DELETE https://teststage.schlaf.de/wp-json/dokan/v1/products/attributes/<id>
This API helps you get all terms of an attribute.
GET https://teststage.schlaf.de/wp-json/dokan/v1/products/attributes/<id>/terms
This API helps you get single term of an attribute.
GET https://teststage.schlaf.de/wp-json/dokan/v1/products/attributes/<id>/terms/<term_id>
This API helps you create an attribute.
POST https://teststage.schlaf.de/wp-json/dokan/v1/products/attributes/<id>/terms
This API helps you to update a term of an attribute.
PUT https://teststage.schlaf.de/wp-json/dokan/v1/products/attributes/<id>/terms/<term_id>
This API helps you delete single term of an attribute.
DELETE https://teststage.schlaf.de/wp-json/dokan/v1/products/attributes/<id>/terms/<term_id>
The orders API allows you to create, view, update, and delete individual, or a batch, of orders.
| 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 |
integer | Version of WooCommerce which last updated the order. read-only |
status |
string | Order status. Options: pending, processing, on-hold, completed, cancelled, refunded and failed. 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. |
shipping |
object | Shipping address. |
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. |
line_items |
array | Line items data. |
tax_lines |
array | Tax lines data. read-only |
shipping_lines |
array | Shipping lines data. |
fee_lines |
array | Fee lines data. |
coupon_lines |
array | Coupons line data. |
refunds |
array | List of refunds. 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 |
| 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. |
| 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. |
| Attribute | Type | Description |
|---|---|---|
id |
integer | Meta ID. read-only |
key |
string | Meta key. |
value |
string | Meta value. |
| 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 |
integer | 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. read-only |
meta_data |
array | Meta data. |
sku |
string | Product SKU. read-only |
price |
string | Product price. read-only |
| 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. |
| 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. read-only |
meta_data |
array | Meta data. |
| 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. read-only |
meta_data |
array | Meta data. |
| Attribute | Type | Description |
|---|---|---|
id |
integer | Item ID. read-only |
code |
string | Coupon code. |
discount |
string | Discount total. |
discount_tax |
string | Discount total tax. read-only |
meta_data |
array | Meta data. |
| Attribute | Type | Description |
|---|---|---|
id |
integer | Refund ID. read-only |
reason |
string | Refund reason. read-only |
total |
string | Refund total. read-only |
This API lets you retrieve and view a specific order.
GET https://teststage.schlaf.de/wp-json/dokan/v1/orders/<id>
This API helps you to view all the orders.
GET https://teststage.schlaf.de/wp-json/dokan/v1/orders/
| Attribute | 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. |
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 |
string | Limit result set to orders assigned a specific status. Options: any, pending, processing, on-hold, completed, cancelled, refunded and failed. 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. |
This API helps you to view all the orders with pagination.
GET https://teststage.schlaf.de/wp-json/dokan/v1/orders/?per_page=2&page=2
| Attribute | 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. |
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 |
string | Limit result set to orders assigned a specific status. Options: any, pending, processing, on-hold, completed, cancelled, refunded and failed. 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. |
This API lets you make changes to an order.
PUT https://teststage.schlaf.de/wp-json/dokan/v1/orders/<id>/?status=wc-pending
This API helps you to get summary of orders.
GET https://teststage.schlaf.de/wp-json/dokan/v1/orders/summary
