Get all countries and regions information for the store
Get all countries and regions information for the store.
curl \
--request GET 'https://magento2.winkelstraat.mac/rest/all/V1/directory/countries'
[
{
"id": "string",
"two_letter_abbreviation": "string",
"three_letter_abbreviation": "string",
"full_name_locale": "string",
"full_name_english": "string",
"available_regions": [
{
"id": "string",
"code": "string",
"name": "string",
"extension_attributes": {}
}
],
"extension_attributes": {}
}
]
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
Remove attribute set by given ID
Remove attribute set by given ID
Path parameters
-
attributeSetId
integer Required
curl \
--request DELETE 'https://magento2.winkelstraat.mac/rest/all/V1/eav/attribute-sets/{attributeSetId}'
true
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
Retrieve customer groups
Retrieve customer groups. The list of groups can be filtered to exclude the NOT_LOGGED_IN group using the first parameter and/or it can be filtered by tax class. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#GroupRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.
Query parameters
-
Field
-
Value
-
Condition type
-
Sorting field.
-
Sorting direction.
-
searchCriteria[pageSize]
integer Page size.
-
searchCriteria[currentPage]
integer Current page.
curl \
--request GET 'https://magento2.winkelstraat.mac/rest/all/V1/customerGroups/search'
{
"items": [
{
"id": 42,
"code": "string",
"tax_class_id": 42,
"tax_class_name": "string",
"extension_attributes": {
"exclude_website_ids": [
42
]
}
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [
{
"field": "string",
"direction": "string"
}
],
"page_size": 42,
"current_page": 42
},
"total_count": 42
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
Query parameters
-
storeId
integer
curl \
--request GET 'https://magento2.winkelstraat.mac/rest/all/V1/customerGroups/default'
{
"id": 42,
"code": "string",
"tax_class_id": 42,
"tax_class_name": "string",
"extension_attributes": {
"exclude_website_ids": [
42
]
}
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
Retrieve all attributes filtered by form code
Retrieve all attributes filtered by form code
Path parameters
-
formCode
string Required
curl \
--request GET 'https://magento2.winkelstraat.mac/rest/all/V1/attributeMetadata/customer/form/{formCode}'
[
{
"frontend_input": "string",
"input_filter": "string",
"store_label": "string",
"validation_rules": [
{
"name": "string",
"value": "string"
}
],
"multiline_count": 42,
"visible": true,
"required": true,
"data_model": "string",
"options": [
{
"label": "string",
"value": "string",
"options": [
{}
]
}
],
"frontend_class": "string",
"user_defined": true,
"sort_order": 42,
"frontend_label": "string",
"note": "string",
"system": true,
"backend_type": "string",
"is_used_in_grid": true,
"is_visible_in_grid": true,
"is_filterable_in_grid": true,
"is_searchable_in_grid": true,
"attribute_code": "string"
}
]
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
Get custom attributes metadata for the given data interface
Get custom attributes metadata for the given data interface.
curl \
--request GET 'https://magento2.winkelstraat.mac/rest/all/V1/attributeMetadata/customer/custom'
[
{
"frontend_input": "string",
"input_filter": "string",
"store_label": "string",
"validation_rules": [
{
"name": "string",
"value": "string"
}
],
"multiline_count": 42,
"visible": true,
"required": true,
"data_model": "string",
"options": [
{
"label": "string",
"value": "string",
"options": [
{}
]
}
],
"frontend_class": "string",
"user_defined": true,
"sort_order": 42,
"frontend_label": "string",
"note": "string",
"system": true,
"backend_type": "string",
"is_used_in_grid": true,
"is_visible_in_grid": true,
"is_filterable_in_grid": true,
"is_searchable_in_grid": true,
"attribute_code": "string"
}
]
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
customerCustomerRepositoryV1
Customer CRUD interface.
Send an email to the customer with a password reset link
Send an email to the customer with a password reset link.
curl \
--request PUT 'https://magento2.winkelstraat.mac/rest/all/V1/customers/password' \
--data '{"email":"string","template":"string","websiteId":42}'
{
"email": "string",
"template": "string",
"websiteId": 42
}
true
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
customerAddressRepositoryV1
Customer address CRUD interface.
Retrieve specific attribute
Retrieve specific attribute
Path parameters
-
attributeCode
string Required
curl \
--request GET 'https://magento2.winkelstraat.mac/rest/all/V1/categories/attributes/{attributeCode}'
{
"is_wysiwyg_enabled": true,
"is_html_allowed_on_front": true,
"used_for_sort_by": true,
"is_filterable": true,
"is_filterable_in_search": true,
"is_used_in_grid": true,
"is_visible_in_grid": true,
"is_filterable_in_grid": true,
"position": 42,
"apply_to": [
"string"
],
"is_searchable": "string",
"is_visible_in_advanced_search": "string",
"is_comparable": "string",
"is_used_for_promo_rules": "string",
"is_visible_on_front": "string",
"used_in_product_listing": "string",
"is_visible": true,
"scope": "string",
"extension_attributes": {},
"attribute_id": 42,
"attribute_code": "string",
"frontend_input": "string",
"entity_type_id": "string",
"is_required": true,
"options": [
{
"label": "string",
"value": "string",
"sort_order": 42,
"is_default": true,
"store_labels": [
{
"store_id": 42,
"label": "string"
}
]
}
],
"is_user_defined": true,
"default_frontend_label": "string",
"frontend_labels": [
{
"store_id": 42,
"label": "string"
}
],
"note": "string",
"backend_type": "string",
"backend_model": "string",
"source_model": "string",
"default_value": "string",
"is_unique": "string",
"frontend_class": "string",
"validation_rules": [
{
"key": "string",
"value": "string"
}
],
"custom_attributes": [
{
"attribute_code": "string",
"value": "string"
}
]
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
Get tier price of product
Get tier price of product
Path parameters
-
sku
string Required -
customerGroupId
string Required 'all' can be used to specify 'ALL GROUPS'
curl \
--request GET 'https://magento2.winkelstraat.mac/rest/all/V1/products/{sku}/group-prices/{customerGroupId}/tiers'
[
{
"customer_group_id": 42,
"qty": 42.0,
"value": 42.0,
"extension_attributes": {
"percentage_value": 42.0,
"website_id": 42
}
}
]
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
catalogTierPriceStorageV1
Tier prices storage.
Remove existing tier prices and replace them with the new ones
Remove existing tier prices and replace them with the new ones. If any items will have invalid price, price type, website id, sku, customer group or quantity, they will be marked as failed and excluded from replace list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the update exception will be thrown.
curl \
--request PUT 'https://magento2.winkelstraat.mac/rest/all/V1/products/tier-prices' \
--data '{"prices":[{"price":42.0,"price_type":"string","website_id":42,"sku":"string","customer_group":"string","quantity":42.0,"extension_attributes":{}}]}'
{
"prices": [
{
"price": 42.0,
"price_type": "string",
"website_id": 42,
"sku": "string",
"customer_group": "string",
"quantity": 42.0,
"extension_attributes": {}
}
]
}
[
{
"message": "string",
"parameters": [
"string"
],
"extension_attributes": {}
}
]
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
Add
Add or update product cost. Input item should correspond to \Magento\Catalog\Api\Data\CostInterface. If any items will have invalid cost, store id or sku, they will be marked as failed and excluded from update list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the update exception will be thrown.
curl \
--request POST 'https://magento2.winkelstraat.mac/rest/all/V1/products/cost' \
--data '{"prices":[{"cost":42.0,"store_id":42,"sku":"string","extension_attributes":{}}]}'
{
"prices": [
{
"cost": 42.0,
"store_id": 42,
"sku": "string",
"extension_attributes": {}
}
]
}
[
{
"message": "string",
"parameters": [
"string"
],
"extension_attributes": {}
}
]
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
Query parameters
-
Field
-
Value
-
Condition type
-
Sorting field.
-
Sorting direction.
-
searchCriteria[pageSize]
integer Page size.
-
searchCriteria[currentPage]
integer Current page.
curl \
--request GET 'https://magento2.winkelstraat.mac/rest/all/V1/categories/list'
{
"items": [
{
"id": 42,
"parent_id": 42,
"name": "string",
"is_active": true,
"position": 42,
"level": 42,
"children": "string",
"created_at": "string",
"updated_at": "string",
"path": "string",
"available_sort_by": [
"string"
],
"include_in_menu": true,
"extension_attributes": {},
"custom_attributes": [
{
"attribute_code": "string",
"value": "string"
}
]
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [
{
"field": "string",
"direction": "string"
}
],
"page_size": 42,
"current_page": 42
},
"total_count": 42
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
Assign a product to the required category
Assign a product to the required category
Path parameters
-
categoryId
string Required
Body
-
productLink
object Required
curl \
--request PUT 'https://magento2.winkelstraat.mac/rest/all/V1/categories/{categoryId}/products' \
--data '{"productLink":{"sku":"string","position":42,"category_id":"string","extension_attributes":{}}}'
{
"productLink": {
"sku": "string",
"position": 42,
"category_id": "string",
"extension_attributes": {}
}
}
true
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
quoteCartRepositoryV1
Interface CartRepositoryInterface
Assigns a specified customer to a specified shopping cart
Assigns a specified customer to a specified shopping cart.
Path parameters
-
cartId
integer Required The cart ID.
Body
-
customerId
integer Required The customer ID.
-
storeId
integer Required
curl \
--request PUT 'https://magento2.winkelstraat.mac/rest/all/V1/carts/{cartId}' \
--data '{"customerId":42,"storeId":42}'
{
"customerId": 42,
"storeId": 42
}
true
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
Lists applicable shipping methods for a specified quote
Lists applicable shipping methods for a specified quote.
Path parameters
-
cartId
integer Required The shopping cart ID.
curl \
--request GET 'https://magento2.winkelstraat.mac/rest/all/V1/carts/{cartId}/shipping-methods'
[
{
"carrier_code": "string",
"method_code": "string",
"carrier_title": "string",
"method_title": "string",
"amount": 42.0,
"base_amount": 42.0,
"available": true,
"extension_attributes": {
"carrier_codes": [
{
"code": "string",
"name": "string"
}
],
"delivery_window_dates": [
{
"carrier_code": "string",
"from": "string",
"to": "string",
"method_title": "string",
"expires": "string"
}
],
"is_pickup_point": true,
"pickup_point": {
"pick_up_point_id": "string",
"carrier_method": "string",
"name": "string",
"address_lines": [
"string"
],
"city": "string",
"state": "string",
"country": "string",
"postal": "string",
"telephone": "string",
"fax": "string"
}
},
"error_message": "string",
"price_excl_tax": 42.0,
"price_incl_tax": 42.0
}
]
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
Return the payment method for a specified shopping cart
Return the payment method for a specified shopping cart.
Path parameters
-
cartId
string Required The cart ID.
curl \
--request GET 'https://magento2.winkelstraat.mac/rest/all/V1/guest-carts/{cartId}/selected-payment-method'
{
"po_number": "string",
"method": "string",
"additional_data": [
"string"
],
"extension_attributes": {
"agreement_ids": [
"string"
],
"origin": "string"
}
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
Returns the billing address for a specified quote
Returns the billing address for a specified quote.
Path parameters
-
cartId
integer Required The cart ID.
curl \
--request GET 'https://magento2.winkelstraat.mac/rest/all/V1/carts/{cartId}/billing-address'
{
"id": 42,
"region": "string",
"region_id": 42,
"region_code": "string",
"country_id": "string",
"street": [
"string"
],
"company": "string",
"telephone": "string",
"fax": "string",
"postcode": "string",
"city": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"prefix": "string",
"suffix": "string",
"vat_id": "string",
"customer_id": 42,
"email": "string",
"same_as_billing": 42,
"customer_address_id": 42,
"save_in_address_book": 42,
"extension_attributes": {
"discounts": [
{
"discount_data": {
"amount": 42.0,
"base_amount": 42.0,
"original_amount": 42.0,
"base_original_amount": 42.0
},
"rule_label": "string",
"rule_i_d": 42
}
],
"gift_registry_id": 42,
"pickup_location_code": "string"
},
"custom_attributes": [
{
"attribute_code": "string",
"value": "string"
}
]
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
Assigns a specified billing address to a specified cart
Assigns a specified billing address to a specified cart.
Path parameters
-
cartId
integer Required The cart ID.
Body
-
address
object Required Interface AddressInterface
-
useForShipping
boolean
curl \
--request POST 'https://magento2.winkelstraat.mac/rest/all/V1/carts/{cartId}/billing-address' \
--data '{"address":{"id":42,"region":"string","region_id":42,"region_code":"string","country_id":"string","street":["string"],"company":"string","telephone":"string","fax":"string","postcode":"string","city":"string","firstname":"string","lastname":"string","middlename":"string","prefix":"string","suffix":"string","vat_id":"string","customer_id":42,"email":"string","same_as_billing":42,"customer_address_id":42,"save_in_address_book":42,"extension_attributes":{"discounts":[{"discount_data":{"amount":42.0,"base_amount":42.0,"original_amount":42.0,"base_original_amount":42.0},"rule_label":"string","rule_i_d":42}],"gift_registry_id":42,"pickup_location_code":"string"},"custom_attributes":[{"attribute_code":"string","value":"string"}]},"useForShipping":true}'
{
"address": {
"id": 42,
"region": "string",
"region_id": 42,
"region_code": "string",
"country_id": "string",
"street": [
"string"
],
"company": "string",
"telephone": "string",
"fax": "string",
"postcode": "string",
"city": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"prefix": "string",
"suffix": "string",
"vat_id": "string",
"customer_id": 42,
"email": "string",
"same_as_billing": 42,
"customer_address_id": 42,
"save_in_address_book": 42,
"extension_attributes": {
"discounts": [
{
"discount_data": {
"amount": 42.0,
"base_amount": 42.0,
"original_amount": 42.0,
"base_original_amount": 42.0
},
"rule_label": "string",
"rule_i_d": 42
}
],
"gift_registry_id": 42,
"pickup_location_code": "string"
},
"custom_attributes": [
{
"attribute_code": "string",
"value": "string"
}
]
},
"useForShipping": true
}
42
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
salesOrderManagementV1
Order management interface. An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as a purchase order, is emailed to the customer.
Path parameters
-
id
integer Required The order ID.
curl \
--request POST 'https://magento2.winkelstraat.mac/rest/all/V1/orders/{id}/hold'
true
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
Releases a specified order from hold status
Releases a specified order from hold status.
Path parameters
-
id
integer Required The order ID.
curl \
--request POST 'https://magento2.winkelstraat.mac/rest/all/V1/orders/{id}/unhold'
true
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
Path parameters
-
id
integer Required The credit memo ID.
curl \
--request PUT 'https://magento2.winkelstraat.mac/rest/all/V1/creditmemo/{id}'
true
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
salesShipOrderV1
Class ShipOrderInterface
salesRuleCouponRepositoryV1
Coupon CRUD interface