Delete downloadable link

Assign attribute to attribute set

POST /V1/products/attribute-sets/attributes

Assign attribute to attribute set

Body

attributeSetId integer Required
attributeGroupId integer Required
attributeCode string Required
sortOrder integer Required

Responses

200

200 Success.
401

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
400

400 Bad Request
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
default

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

POST /V1/products/attribute-sets/attributes

curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/products/attribute-sets/attributes' \
 --data '{"attributeSetId":42,"attributeGroupId":42,"attributeCode":"string","sortOrder":42}'

Request examples

{
  "attributeSetId": 42,
  "attributeGroupId": 42,
  "attributeCode": "string",
  "sortOrder": 42
}

Response examples (200)

Response examples (401)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (400)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (default)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Retrieve the list of media attributes

GET /V1/products/media/types/{attributeSetName}

Retrieve the list of media attributes (fronted input type is media_image) assigned to the given attribute set.

Path parameters

attributeSetName string Required

Responses

200

200 Success.
Hide response attributes Show response attributes object
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Eav\Api\Data\AttributeInterface
  
  Hide extension_attributes attribute Show extension_attributes attribute object
  
  is_pagebuilder_enabled boolean
- is_wysiwyg_enabled boolean
  
  WYSIWYG flag
- is_html_allowed_on_front boolean
  
  The HTML tags are allowed on the frontend
- used_for_sort_by boolean
  
  It is used for sorting in product listing
- is_filterable boolean
  
  It used in layered navigation
- is_filterable_in_search boolean
  
  It is used in search results layered navigation
- is_used_in_grid boolean
  
  It is used in catalog product grid
- is_visible_in_grid boolean
  
  It is visible in catalog product grid
- is_filterable_in_grid boolean
  
  It is filterable in catalog product grid
- position integer
  
  Position
- apply_to array[string]
  
  Apply to value for the element
- is_searchable string
  
  The attribute can be used in Quick Search
- is_visible_in_advanced_search string
  
  The attribute can be used in Advanced Search
- is_comparable string
  
  The attribute can be compared on the frontend
- is_used_for_promo_rules string
  
  The attribute can be used for promo rules
- is_visible_on_front string
  
  The attribute is visible on the frontend
- used_in_product_listing string
  
  The attribute can be used in product listing
- is_visible boolean
  
  Attribute is visible on frontend.
- scope string
  
  Attribute scope
- attribute_id integer
  
  Id of the attribute.
- attribute_code string Required
  
  Code of the attribute.
- frontend_input string Required
  
  HTML for input element.
- entity_type_id string Required
  
  Entity type id
- is_required boolean Required
  
  Attribute is required.
- options array[object]
  
  Created from:
  
  Created from:
  
  Hide options attributes Show options attributes object
  
  label string Required
  
  Option label
  
  value string Required
  
  Option value
  
  sort_order integer
  
  Option order
  
  is_default boolean
  
  Default
  
  store_labels array[object]
  
  Interface AttributeOptionLabelInterface
  
  Interface AttributeOptionLabelInterface
  
  Hide store_labels attributes Show store_labels attributes object
  
  store_id integer
  
  Store id
  
  label string
  
  Option label
- is_user_defined boolean
  
  Current attribute has been defined by a user.
- default_frontend_label string
  
  Frontend label for default store
- frontend_labels array[object] Required
  
  Interface AttributeFrontendLabelInterface
  
  Interface AttributeFrontendLabelInterface
  
  Hide frontend_labels attributes Show frontend_labels attributes object
  
  store_id integer
  
  Store id
  
  label string
  
  Option label
- note string
  
  The note attribute for the element.
- backend_type string
  
  Backend type.
- backend_model string
  
  Backend model
- source_model string
  
  Source model
- default_value string
  
  Default value for the element.
- is_unique string
  
  This is a unique attribute
- frontend_class string
  
  Frontend class of attribute
- validation_rules array[object]
  
  Interface AttributeValidationRuleInterface
  
  Interface AttributeValidationRuleInterface
  
  Hide validation_rules attributes Show validation_rules attributes object
  
  key string Required
  
  Object key
  
  value string Required
  
  Object value
- custom_attributes array[object]
  
  Interface for custom attribute value.
  
  Interface for custom attribute value.
  
  Hide custom_attributes attributes Show custom_attributes attributes object
  
  attribute_code string Required
  
  Attribute code
  
  value string Required
  
  Attribute value
default

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

GET /V1/products/media/types/{attributeSetName}

curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/products/media/types/{attributeSetName}'

Response examples (200)

[
  {
    "extension_attributes": {
      "is_pagebuilder_enabled": true
    },
    "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",
    "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"
      }
    ]
  }
]

Response examples (default)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Delete v1 products sku options option

DELETE /V1/products/{sku}/options/{optionId}

Path parameters

sku string Required
optionId integer Required

Responses

200

200 Success.
401

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
default

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

DELETE /V1/products/{sku}/options/{optionId}

curl \
 --request DELETE 'https://magento2.winkelstraat.mac/rest/all/V1/products/{sku}/options/{optionId}'

Response examples (200)

true

Response examples (401)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (default)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Remove the website assignment from the product by product sku

DELETE /V1/products/{sku}/websites/{websiteId}

Remove the website assignment from the product by product sku

Path parameters

sku string Required
websiteId integer Required

Responses

200

200 Success.

will returned True if website successfully unassigned from product
401

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
400

400 Bad Request
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
default

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

DELETE /V1/products/{sku}/websites/{websiteId}

curl \
 --request DELETE 'https://magento2.winkelstraat.mac/rest/all/V1/products/{sku}/websites/{websiteId}'

Response examples (200)

true

Response examples (401)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (400)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (default)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Estimate shipping

POST /V1/purchase-order-carts/{cartId}/estimate-shipping-methods-by-address-id

Estimate shipping

Path parameters

cartId integer Required

The shopping cart ID.

Body

addressId integer Required

The estimate address id

Responses

200

200 Success.
Hide response attributes Show response attributes object
- carrier_code string Required
  
  Shipping carrier code.
- method_code string Required
  
  Shipping method code.
- carrier_title string
  
  Shipping carrier title. Otherwise, null.
- method_title string
  
  Shipping method title. Otherwise, null.
- amount number Required
  
  Shipping amount in store currency.
- base_amount number Required
  
  Shipping amount in base currency.
- available boolean Required
  
  The value of the availability flag for the current shipping method.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingMethodInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  carrier_codes array[object]
  
  Hide carrier_codes attributes Show carrier_codes attributes object
  
  code string Required
  
  name string Required
  
  delivery_window_dates array[object]
  
  Hide delivery_window_dates attributes Show delivery_window_dates attributes object
  
  carrier_code string Required
  
  from string Required
  
  to string Required
  
  method_title string Required
  
  expires string Required
  
  is_pickup_point boolean
  
  pickup_point object
  
  Hide pickup_point attributes Show pickup_point attributes object
  
  pick_up_point_id string Required
  
  carrier_method string Required
  
  name string
  
  address_lines array[string] Required
  
  city string Required
  
  state string
  
  country string Required
  
  postal string Required
  
  telephone string
  
  fax string
- error_message string Required
  
  Shipping Error message.
- price_excl_tax number Required
  
  Shipping price excl tax.
- price_incl_tax number Required
  
  Shipping price incl tax.
401

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
default

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

POST /V1/purchase-order-carts/{cartId}/estimate-shipping-methods-by-address-id

curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/purchase-order-carts/{cartId}/estimate-shipping-methods-by-address-id' \
 --data '{"addressId":42}'

Request examples

{
  "addressId": 42
}

Response examples (200)

[
  {
    "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
  }
]

Response examples (401)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (default)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Remove the specified item from the specified cart

DELETE /V1/guest-carts/{cartId}/items/{itemId}

Remove the specified item from the specified cart.

Path parameters

cartId string Required

The cart ID.
itemId integer Required

The item ID of the item to be removed.

Responses

200

200 Success.
400

400 Bad Request
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
default

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

DELETE /V1/guest-carts/{cartId}/items/{itemId}

curl \
 --request DELETE 'https://magento2.winkelstraat.mac/rest/all/V1/guest-carts/{cartId}/items/{itemId}'

Response examples (200)

true

Response examples (400)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (default)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Returns quote totals data for a specified cart

GET /V1/carts/{cartId}/totals

Returns quote totals data for a specified cart.

Path parameters

cartId integer Required

The cart ID.

Responses

200

200 Success.
Hide response attributes Show response attributes object
- grand_total number
  
  Grand total in quote currency
- base_grand_total number
  
  Grand total in base currency
- subtotal number
  
  Subtotal in quote currency
- base_subtotal number
  
  Subtotal in base currency
- discount_amount number
  
  Discount amount in quote currency
- base_discount_amount number
  
  Discount amount in base currency
- subtotal_with_discount number
  
  Subtotal in quote currency with applied discount
- base_subtotal_with_discount number
  
  Subtotal in base currency with applied discount
- shipping_amount number
  
  Shipping amount in quote currency
- base_shipping_amount number
  
  Shipping amount in base currency
- shipping_discount_amount number
  
  Shipping discount amount in quote currency
- base_shipping_discount_amount number
  
  Shipping discount amount in base currency
- tax_amount number
  
  Tax amount in quote currency
- base_tax_amount number
  
  Tax amount in base currency
- weee_tax_applied_amount number Required
  
  Item weee tax applied amount in quote currency.
- shipping_tax_amount number
  
  Shipping tax amount in quote currency
- base_shipping_tax_amount number
  
  Shipping tax amount in base currency
- subtotal_incl_tax number
  
  Subtotal including tax in quote currency
- base_subtotal_incl_tax number
  
  Subtotal including tax in base currency
- shipping_incl_tax number
  
  Shipping including tax in quote currency
- base_shipping_incl_tax number
  
  Shipping including tax in base currency
- base_currency_code string
  
  Base currency code
- quote_currency_code string
  
  Quote currency code
- coupon_code string
  
  Applied coupon code
- items_qty integer
  
  Items qty
- items array[object]
  
  Interface TotalsItemInterface
  
  Interface TotalsItemInterface
  
  Hide items attributes Show items attributes object
  
  item_id integer Required
  
  Item id
  
  price number Required
  
  Item price in quote currency.
  
  base_price number Required
  
  Item price in base currency.
  
  qty number Required
  
  Item quantity.
  
  row_total number Required
  
  Row total in quote currency.
  
  base_row_total number Required
  
  Row total in base currency.
  
  row_total_with_discount number
  
  Row total with discount in quote currency. Otherwise, null.
  
  tax_amount number
  
  Tax amount in quote currency. Otherwise, null.
  
  base_tax_amount number
  
  Tax amount in base currency. Otherwise, null.
  
  tax_percent number
  
  Tax percent. Otherwise, null.
  
  discount_amount number
  
  Discount amount in quote currency. Otherwise, null.
  
  base_discount_amount number
  
  Discount amount in base currency. Otherwise, null.
  
  discount_percent number
  
  Discount percent. Otherwise, null.
  
  price_incl_tax number
  
  Price including tax in quote currency. Otherwise, null.
  
  base_price_incl_tax number
  
  Price including tax in base currency. Otherwise, null.
  
  row_total_incl_tax number
  
  Row total including tax in quote currency. Otherwise, null.
  
  base_row_total_incl_tax number
  
  Row total including tax in base currency. Otherwise, null.
  
  options string Required
  
  Item price in quote currency.
  
  weee_tax_applied_amount number Required
  
  Item weee tax applied amount in quote currency.
  
  weee_tax_applied string Required
  
  Item weee tax applied in quote currency.
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsItemInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  negotiable_quote_item_totals object
  
  Extension attribute for quote item totals model.
  
  Hide negotiable_quote_item_totals attributes Show negotiable_quote_item_totals attributes object
  
  cost number Required
  
  Cost for quote item.
  
  catalog_price number Required
  
  Catalog price for quote item.
  
  base_catalog_price number Required
  
  Catalog price for quote item in base currency.
  
  catalog_price_incl_tax number Required
  
  Catalog price with included tax for quote item.
  
  base_catalog_price_incl_tax number Required
  
  Catalog price with included tax for quote item in base currency.
  
  cart_price number Required
  
  Cart price for quote item.
  
  base_cart_price number Required
  
  Cart price for quote item in base currency.
  
  cart_tax number Required
  
  Tax from catalog price for quote item.
  
  base_cart_tax number Required
  
  Tax from catalog price for quote item in base currency.
  
  cart_price_incl_tax number Required
  
  Cart price with included tax for quote item.
  
  base_cart_price_incl_tax number Required
  
  Cart price with included tax for quote item in base currency.
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemTotalsInterface
  
  sku string
  
  manufacturer_name string
  
  regular_price_incl_tax string
  
  name string
  
  Product name. Otherwise, null.
- total_segments array[object] Required
  
  Interface TotalsInterface
  
  Interface TotalsInterface
  
  Hide total_segments attributes Show total_segments attributes object
  
  code string Required
  
  Code
  
  title string
  
  Total title
  
  value number Required
  
  Total value
  
  area string
  
  Display area code.
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalSegmentInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  tax_grandtotal_details array[object]
  
  Interface GrandTotalDetailsInterface
  
  Interface GrandTotalDetailsInterface
  
  Hide tax_grandtotal_details attributes Show tax_grandtotal_details attributes object
  
  amount number Required
  
  Tax amount value
  
  rates array[object] Required
  
  Interface GrandTotalRatesInterface
  
  Interface GrandTotalRatesInterface
  
  Hide rates attributes Show rates attributes object
  
  percent string Required
  
  Tax percentage value
  
  title string Required
  
  Rate title
  
  group_id integer Required
  
  Group identifier
  
  gift_cards string
  
  gw_order_id string
  
  gw_item_ids array[string]
  
  gw_allow_gift_receipt string
  
  gw_add_card string
  
  gw_price string
  
  gw_base_price string
  
  gw_items_price string
  
  gw_items_base_price string
  
  gw_card_price string
  
  gw_card_base_price string
  
  gw_base_tax_amount string
  
  gw_tax_amount string
  
  gw_items_base_tax_amount string
  
  gw_items_tax_amount string
  
  gw_card_base_tax_amount string
  
  gw_card_tax_amount string
  
  gw_price_incl_tax string
  
  gw_base_price_incl_tax string
  
  gw_card_price_incl_tax string
  
  gw_card_base_price_incl_tax string
  
  gw_items_price_incl_tax string
  
  gw_items_base_price_incl_tax string
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  coupon_label string
  
  negotiable_quote_totals object
  
  Extension attribute for quote totals model.
  
  Hide negotiable_quote_totals attributes Show negotiable_quote_totals attributes object
  
  items_count integer Required
  
  The number of different items or products in the cart.
  
  quote_status string Required
  
  Negotiable quote status.
  
  created_at string Required
  
  The cart creation date and time.
  
  updated_at string Required
  
  The cart last update date and time.
  
  customer_group integer Required
  
  Customer group id.
  
  base_to_quote_rate number Required
  
  Base currency to quote currency rate.
  
  cost_total number Required
  
  Total cost for quote.
  
  base_cost_total number Required
  
  Total cost for quote in base currency.
  
  original_total number Required
  
  Original quote total.
  
  base_original_total number Required
  
  Original quote total in base currency.
  
  original_tax number Required
  
  Original tax amount for quote.
  
  base_original_tax number Required
  
  Original tax amount for quote in base currency.
  
  original_price_incl_tax number Required
  
  Original price with included tax for quote.
  
  base_original_price_incl_tax number Required
  
  Original price with included tax for quote in base currency.
  
  negotiated_price_type integer Required
  
  Negotiable quote type.
  
  negotiated_price_value number Required
  
  Negotiable price value for quote.
  
  base_customer_balance_amount number
  
  customer_balance_amount number
  
  coupon_codes array[string]
  
  coupons_labels array[string]
  
  reward_points_balance number
  
  reward_currency_amount number
  
  base_reward_currency_amount number
401

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
400

400 Bad Request
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
default

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

GET /V1/carts/{cartId}/totals

curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/carts/{cartId}/totals'

Response examples (200)

{
  "grand_total": 42.0,
  "base_grand_total": 42.0,
  "subtotal": 42.0,
  "base_subtotal": 42.0,
  "discount_amount": 42.0,
  "base_discount_amount": 42.0,
  "subtotal_with_discount": 42.0,
  "base_subtotal_with_discount": 42.0,
  "shipping_amount": 42.0,
  "base_shipping_amount": 42.0,
  "shipping_discount_amount": 42.0,
  "base_shipping_discount_amount": 42.0,
  "tax_amount": 42.0,
  "base_tax_amount": 42.0,
  "weee_tax_applied_amount": 42.0,
  "shipping_tax_amount": 42.0,
  "base_shipping_tax_amount": 42.0,
  "subtotal_incl_tax": 42.0,
  "base_subtotal_incl_tax": 42.0,
  "shipping_incl_tax": 42.0,
  "base_shipping_incl_tax": 42.0,
  "base_currency_code": "string",
  "quote_currency_code": "string",
  "coupon_code": "string",
  "items_qty": 42,
  "items": [
    {
      "item_id": 42,
      "price": 42.0,
      "base_price": 42.0,
      "qty": 42.0,
      "row_total": 42.0,
      "base_row_total": 42.0,
      "row_total_with_discount": 42.0,
      "tax_amount": 42.0,
      "base_tax_amount": 42.0,
      "tax_percent": 42.0,
      "discount_amount": 42.0,
      "base_discount_amount": 42.0,
      "discount_percent": 42.0,
      "price_incl_tax": 42.0,
      "base_price_incl_tax": 42.0,
      "row_total_incl_tax": 42.0,
      "base_row_total_incl_tax": 42.0,
      "options": "string",
      "weee_tax_applied_amount": 42.0,
      "weee_tax_applied": "string",
      "extension_attributes": {
        "negotiable_quote_item_totals": {
          "cost": 42.0,
          "catalog_price": 42.0,
          "base_catalog_price": 42.0,
          "catalog_price_incl_tax": 42.0,
          "base_catalog_price_incl_tax": 42.0,
          "cart_price": 42.0,
          "base_cart_price": 42.0,
          "cart_tax": 42.0,
          "base_cart_tax": 42.0,
          "cart_price_incl_tax": 42.0,
          "base_cart_price_incl_tax": 42.0,
          "extension_attributes": {}
        },
        "sku": "string",
        "manufacturer_name": "string",
        "regular_price_incl_tax": "string"
      },
      "name": "string"
    }
  ],
  "total_segments": [
    {
      "code": "string",
      "title": "string",
      "value": 42.0,
      "area": "string",
      "extension_attributes": {
        "tax_grandtotal_details": [
          {
            "amount": 42.0,
            "rates": [
              {
                "percent": "string",
                "title": "string"
              }
            ],
            "group_id": 42
          }
        ],
        "gift_cards": "string",
        "gw_order_id": "string",
        "gw_item_ids": [
          "string"
        ],
        "gw_allow_gift_receipt": "string",
        "gw_add_card": "string",
        "gw_price": "string",
        "gw_base_price": "string",
        "gw_items_price": "string",
        "gw_items_base_price": "string",
        "gw_card_price": "string",
        "gw_card_base_price": "string",
        "gw_base_tax_amount": "string",
        "gw_tax_amount": "string",
        "gw_items_base_tax_amount": "string",
        "gw_items_tax_amount": "string",
        "gw_card_base_tax_amount": "string",
        "gw_card_tax_amount": "string",
        "gw_price_incl_tax": "string",
        "gw_base_price_incl_tax": "string",
        "gw_card_price_incl_tax": "string",
        "gw_card_base_price_incl_tax": "string",
        "gw_items_price_incl_tax": "string",
        "gw_items_base_price_incl_tax": "string"
      }
    }
  ],
  "extension_attributes": {
    "coupon_label": "string",
    "negotiable_quote_totals": {
      "items_count": 42,
      "quote_status": "string",
      "created_at": "string",
      "updated_at": "string",
      "customer_group": 42,
      "base_to_quote_rate": 42.0,
      "cost_total": 42.0,
      "base_cost_total": 42.0,
      "original_total": 42.0,
      "base_original_total": 42.0,
      "original_tax": 42.0,
      "base_original_tax": 42.0,
      "original_price_incl_tax": 42.0,
      "base_original_price_incl_tax": 42.0,
      "negotiated_price_type": 42,
      "negotiated_price_value": 42.0
    },
    "base_customer_balance_amount": 42.0,
    "customer_balance_amount": 42.0,
    "coupon_codes": [
      "string"
    ],
    "coupons_labels": [
      "string"
    ],
    "reward_points_balance": 42.0,
    "reward_currency_amount": 42.0,
    "base_reward_currency_amount": 42.0
  }
}

Response examples (401)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (400)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (default)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Performs persist operations for a specified order address

PUT /V1/orders/{parent_id}

Performs persist operations for a specified order address.

Path parameters

parent_id string Required

Body

entity object Required

Order address 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.
Hide entity attributes Show entity attributes object
- address_type string Required
  
  Address type.
- city string Required
  
  City.
- company string
  
  Company.
- country_id string Required
  
  Country ID.
- customer_address_id integer
  
  Country address ID.
- customer_id integer
  
  Customer ID.
- email string
  
  Email address.
- entity_id integer
  
  Order address ID.
- fax string
  
  Fax number.
- firstname string Required
  
  First name.
- lastname string Required
  
  Last name.
- middlename string
  
  Middle name.
- parent_id integer
  
  Parent ID.
- postcode string Required
  
  Postal code.
- prefix string
  
  Prefix.
- region string
  
  Region.
- region_code string
  
  Region code.
- region_id integer
  
  Region ID.
- street array[string]
  
  Array of any street values. Otherwise, null.
- suffix string
  
  Suffix.
- telephone string Required
  
  Telephone number.
- vat_id string
  
  VAT ID.
- vat_is_valid integer
  
  VAT-is-valid flag value.
- vat_request_date string
  
  VAT request date.
- vat_request_id string
  
  VAT request ID.
- vat_request_success integer
  
  VAT-request-success flag value.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Sales\Api\Data\OrderAddressInterface

Responses

200

200 Success.
Hide response attributes Show response attributes object
- address_type string Required
  
  Address type.
- city string Required
  
  City.
- company string
  
  Company.
- country_id string Required
  
  Country ID.
- customer_address_id integer
  
  Country address ID.
- customer_id integer
  
  Customer ID.
- email string
  
  Email address.
- entity_id integer
  
  Order address ID.
- fax string
  
  Fax number.
- firstname string Required
  
  First name.
- lastname string Required
  
  Last name.
- middlename string
  
  Middle name.
- parent_id integer
  
  Parent ID.
- postcode string Required
  
  Postal code.
- prefix string
  
  Prefix.
- region string
  
  Region.
- region_code string
  
  Region code.
- region_id integer
  
  Region ID.
- street array[string]
  
  Array of any street values. Otherwise, null.
- suffix string
  
  Suffix.
- telephone string Required
  
  Telephone number.
- vat_id string
  
  VAT ID.
- vat_is_valid integer
  
  VAT-is-valid flag value.
- vat_request_date string
  
  VAT request date.
- vat_request_id string
  
  VAT request ID.
- vat_request_success integer
  
  VAT-request-success flag value.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Sales\Api\Data\OrderAddressInterface
401

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
default

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

PUT /V1/orders/{parent_id}

curl \
 --request PUT 'https://magento2.winkelstraat.mac/rest/all/V1/orders/{parent_id}' \
 --data '{"entity":{"address_type":"string","city":"string","company":"string","country_id":"string","customer_address_id":42,"customer_id":42,"email":"string","entity_id":42,"fax":"string","firstname":"string","lastname":"string","middlename":"string","parent_id":42,"postcode":"string","prefix":"string","region":"string","region_code":"string","region_id":42,"street":["string"],"suffix":"string","telephone":"string","vat_id":"string","vat_is_valid":42,"vat_request_date":"string","vat_request_id":"string","vat_request_success":42,"extension_attributes":{}}}'

Request examples

{
  "entity": {
    "address_type": "string",
    "city": "string",
    "company": "string",
    "country_id": "string",
    "customer_address_id": 42,
    "customer_id": 42,
    "email": "string",
    "entity_id": 42,
    "fax": "string",
    "firstname": "string",
    "lastname": "string",
    "middlename": "string",
    "parent_id": 42,
    "postcode": "string",
    "prefix": "string",
    "region": "string",
    "region_code": "string",
    "region_id": 42,
    "street": [
      "string"
    ],
    "suffix": "string",
    "telephone": "string",
    "vat_id": "string",
    "vat_is_valid": 42,
    "vat_request_date": "string",
    "vat_request_id": "string",
    "vat_request_success": 42,
    "extension_attributes": {}
  }
}

Response examples (200)

{
  "address_type": "string",
  "city": "string",
  "company": "string",
  "country_id": "string",
  "customer_address_id": 42,
  "customer_id": 42,
  "email": "string",
  "entity_id": 42,
  "fax": "string",
  "firstname": "string",
  "lastname": "string",
  "middlename": "string",
  "parent_id": 42,
  "postcode": "string",
  "prefix": "string",
  "region": "string",
  "region_code": "string",
  "region_id": 42,
  "street": [
    "string"
  ],
  "suffix": "string",
  "telephone": "string",
  "vat_id": "string",
  "vat_is_valid": 42,
  "vat_request_date": "string",
  "vat_request_id": "string",
  "vat_request_success": 42,
  "extension_attributes": {}
}

Response examples (401)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (default)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Delete coupon by coupon id

DELETE /V1/coupons/{couponId}

Delete coupon by coupon id.

Path parameters

couponId integer Required

Responses

200

200 Success.

true on success
401

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
400

400 Bad Request
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
500

Internal Server error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
default

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

DELETE /V1/coupons/{couponId}

curl \
 --request DELETE 'https://magento2.winkelstraat.mac/rest/all/V1/coupons/{couponId}'

Response examples (200)

true

Response examples (401)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (400)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (500)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (default)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

DELETE /V1/products/downloadable-links/{id}

Delete downloadable link

Path parameters

id integer Required

Responses

200

200 Success.
401

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
default

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

DELETE /V1/products/downloadable-links/{id}

curl \
 --request DELETE 'https://magento2.winkelstraat.mac/rest/all/V1/products/downloadable-links/{id}'

Response examples (200)

true

Response examples (401)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (default)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

storeWebsiteRepositoryV1

customerAddressRepositoryV1

Assign attribute to attribute set

Body

Responses

Retrieve the list of media attributes

Path parameters

Responses

Delete v1 products sku options option

Path parameters

Responses

Remove the website assignment from the product by product sku

Path parameters

Responses

quoteCartManagementV1

Estimate shipping

Path parameters

Body

Responses

Remove the specified item from the specified cart

Path parameters

Responses

Returns quote totals data for a specified cart

Path parameters

Responses

Performs persist operations for a specified order address

Path parameters

Body

Responses

Delete coupon by coupon id

Path parameters

Responses

checkoutShippingInformationManagementV1

checkoutGuestTotalsInformationManagementV1