\WinkelstraatShippingPackedExternalShipmentPackedResetV1

Retrieve all attributes for entity type

GET /V1/products/attributes

Retrieve all attributes for entity type

Query parameters

searchCriteria[filterGroups][0][filters][0][field] string

Field
searchCriteria[filterGroups][0][filters][0][value] string

Value
searchCriteria[filterGroups][0][filters][0][conditionType] string

Condition type
searchCriteria[sortOrders][0][field] string

Sorting field.
searchCriteria[sortOrders][0][direction] string

Sorting direction.
searchCriteria[pageSize] integer

Page size.
searchCriteria[currentPage] integer

Current page.

Responses

200

200 Success.
Hide response attributes Show response attributes object
- items array[object] Required
  
  Hide items attributes Show items 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
- search_criteria object Required
  
  Search criteria interface.
  
  Hide search_criteria attributes Show search_criteria attributes object
  
  filter_groups array[object] Required
  
  Groups two or more filters together using a logical OR
  
  Groups two or more filters together using a logical OR
  
  Hide filter_groups attribute Show filter_groups attribute object
  
  filters array[object]
  
  Filter which can be used by any methods from service layer.
  
  Filter which can be used by any methods from service layer.
  
  Hide filters attributes Show filters attributes object
  
  field string Required
  
  Field
  
  value string Required
  
  Value
  
  condition_type string
  
  Condition type
  
  sort_orders array[object]
  
  Data object for sort order.
  
  Data object for sort order.
  
  Hide sort_orders attributes Show sort_orders attributes object
  
  field string Required
  
  Sorting field.
  
  direction string Required
  
  Sorting direction.
  
  page_size integer
  
  Page size.
  
  current_page integer
  
  Current page.
- total_count integer Required
  
  Total count.
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

GET /V1/products/attributes

curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/products/attributes'

Response examples (200)

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

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"
}

Return product prices

POST /V1/products/cost-information

Return product prices. In case of at least one of skus is not found exception will be thrown.

Body

skus array[string] Required

Responses

200

200 Success.
Hide response attributes Show response attributes object
- cost number Required
  
  Cost value.
- store_id integer Required
  
  Store id.
- sku string Required
  
  SKU.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Catalog\Api\Data\CostInterface
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/cost-information

curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/products/cost-information' \
 --data '{"skus":["string"]}'

Request examples

{
  "skus": [
    "string"
  ]
}

Response examples (200)

[
  {
    "cost": 42.0,
    "store_id": 42,
    "sku": "string",
    "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 (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 by address and return list of available shipping methods

POST /V1/carts/mine/estimate-shipping-methods

Estimate shipping by address and return list of available shipping methods

Body

address object Required

Interface AddressInterface
Hide address attributes Show address attributes object
- id integer
  
  Id
- region string Required
  
  Region name
- region_id integer Required
  
  Region id
- region_code string Required
  
  Region code
- country_id string Required
  
  Country id
- street array[string] Required
  
  Street
- company string
  
  Company
- telephone string Required
  
  Telephone number
- fax string
  
  Fax number
- postcode string Required
  
  Postcode
- city string Required
  
  City name
- firstname string Required
  
  First name
- lastname string Required
  
  Last name
- middlename string
  
  Middle name
- prefix string
  
  Prefix
- suffix string
  
  Suffix
- vat_id string
  
  Vat id
- customer_id integer
  
  Customer id
- email string Required
  
  Billing/shipping email
- same_as_billing integer
  
  Same as billing flag
- customer_address_id integer
  
  Customer address id
- save_in_address_book integer
  
  Save in address book flag
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Quote\Api\Data\AddressInterface
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  discounts array[object]
  
  Rule discount Interface
  
  Rule discount Interface
  
  Hide discounts attributes Show discounts attributes object
  
  discount_data object Required
  
  Discount Data Interface
  
  Hide discount_data attributes Show discount_data attributes object
  
  amount number Required
  
  Amount
  
  base_amount number Required
  
  Base Amount
  
  original_amount number Required
  
  Original Amount
  
  base_original_amount number Required
  
  Base Original Amount
  
  rule_label string Required
  
  Rule Label
  
  rule_i_d integer Required
  
  Rule ID
  
  gift_registry_id integer
  
  pickup_location_code string
- 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

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
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/carts/mine/estimate-shipping-methods

curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/carts/mine/estimate-shipping-methods' \
 --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"}]}}'

Request examples

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

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 (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"
}

Adds a specified payment method to a specified shopping cart

PUT /V1/carts/mine/selected-payment-method

Adds a specified payment method to a specified shopping cart.

Body

method object Required

Interface PaymentInterface
Hide method attributes Show method attributes object
- po_number string
  
  Purchase order number
- method string Required
  
  Payment method code
- additional_data array[string]
  
  Payment additional details
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Quote\Api\Data\PaymentInterface
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  agreement_ids array[string]
  
  origin string

Responses

200

200 Success.

redirect url or error message.
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

PUT /V1/carts/mine/selected-payment-method

curl \
 --request PUT 'https://magento2.winkelstraat.mac/rest/all/V1/carts/mine/selected-payment-method' \
 --data '{"method":{"po_number":"string","method":"string","additional_data":["string"],"extension_attributes":{"agreement_ids":["string"],"origin":"string"}}}'

Request examples

{
  "method": {
    "po_number": "string",
    "method": "string",
    "additional_data": [
      "string"
    ],
    "extension_attributes": {
      "agreement_ids": [
        "string"
      ],
      "origin": "string"
    }
  }
}

Response examples (200)

string

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"
}

Save sales rule

POST /V1/salesRules

Save sales rule.

Body

rule object Required

Interface RuleInterface
Hide rule attributes Show rule attributes object
- rule_id integer
  
  Rule id
- name string
  
  Rule name
- store_labels array[object]
  
  Interface RuleLabelInterface
  
  Interface RuleLabelInterface
  Hide store_labels attributes Show store_labels attributes object
  
  store_id integer Required
  
  StoreId
  
  store_label string Required
  
  The label for the store
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\SalesRule\Api\Data\RuleLabelInterface
- description string
  
  Description
- website_ids array[integer] Required
  
  A list of websites the rule applies to
- customer_group_ids array[integer] Required
  
  Ids of customer groups that the rule applies to
- from_date string
  
  The start date when the coupon is active
- to_date string
  
  The end date when the coupon is active
- uses_per_customer integer Required
  
  Number of uses per customer
- is_active boolean Required
  
  The coupon is active
- condition object
  
  Interface ConditionInterface
  Hide condition attributes Show condition attributes object
  
  condition_type string Required
  
  Condition type
  
  conditions array[object]
  
  Interface ConditionInterface
  
  Interface ConditionInterface
  
  Interface ConditionInterface
  
  aggregator_type string
  
  The aggregator type
  
  operator string Required
  
  The operator of the condition
  
  attribute_name string
  
  The attribute name of the condition
  
  value string Required
  
  The value of the condition
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\SalesRule\Api\Data\ConditionInterface
- action_condition object
  
  Interface ConditionInterface
  Hide action_condition attributes Show action_condition attributes object
  
  condition_type string Required
  
  Condition type
  
  conditions array[object]
  
  Interface ConditionInterface
  
  Interface ConditionInterface
  
  Interface ConditionInterface
  
  aggregator_type string
  
  The aggregator type
  
  operator string Required
  
  The operator of the condition
  
  attribute_name string
  
  The attribute name of the condition
  
  value string Required
  
  The value of the condition
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\SalesRule\Api\Data\ConditionInterface
- stop_rules_processing boolean Required
  
  To stop rule processing
- is_advanced boolean Required
  
  Is this field needed
- product_ids array[integer]
  
  Product ids
- sort_order integer Required
  
  Sort order
- simple_action string
  
  Simple action of the rule
- discount_amount number Required
  
  Discount amount
- discount_qty number
  
  Maximum qty discount is applied
- discount_step integer Required
  
  Discount step
- apply_to_shipping boolean Required
  
  The rule applies to shipping
- times_used integer Required
  
  How many times the rule has been used
- is_rss boolean Required
  
  Whether the rule is in RSS
- coupon_type string Required
  
  Coupon type
- use_auto_generation boolean Required
  
  To auto generate coupon
- uses_per_coupon integer Required
  
  Limit of uses per coupon
- simple_free_shipping string
  
  To grant free shipping
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\SalesRule\Api\Data\RuleInterface
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  reward_points_delta integer
  
  product_groups array[string]

Responses

200

200 Success.
Hide response attributes Show response attributes object
- rule_id integer
  
  Rule id
- name string
  
  Rule name
- store_labels array[object]
  
  Interface RuleLabelInterface
  
  Interface RuleLabelInterface
  
  Hide store_labels attributes Show store_labels attributes object
  
  store_id integer Required
  
  StoreId
  
  store_label string Required
  
  The label for the store
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\SalesRule\Api\Data\RuleLabelInterface
- description string
  
  Description
- website_ids array[integer] Required
  
  A list of websites the rule applies to
- customer_group_ids array[integer] Required
  
  Ids of customer groups that the rule applies to
- from_date string
  
  The start date when the coupon is active
- to_date string
  
  The end date when the coupon is active
- uses_per_customer integer Required
  
  Number of uses per customer
- is_active boolean Required
  
  The coupon is active
- condition object
  
  Interface ConditionInterface
  
  Hide condition attributes Show condition attributes object
  
  condition_type string Required
  
  Condition type
  
  conditions array[object]
  
  Interface ConditionInterface
  
  Interface ConditionInterface
  
  Interface ConditionInterface
  
  aggregator_type string
  
  The aggregator type
  
  operator string Required
  
  The operator of the condition
  
  attribute_name string
  
  The attribute name of the condition
  
  value string Required
  
  The value of the condition
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\SalesRule\Api\Data\ConditionInterface
- action_condition object
  
  Interface ConditionInterface
  
  Hide action_condition attributes Show action_condition attributes object
  
  condition_type string Required
  
  Condition type
  
  conditions array[object]
  
  Interface ConditionInterface
  
  Interface ConditionInterface
  
  Interface ConditionInterface
  
  aggregator_type string
  
  The aggregator type
  
  operator string Required
  
  The operator of the condition
  
  attribute_name string
  
  The attribute name of the condition
  
  value string Required
  
  The value of the condition
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\SalesRule\Api\Data\ConditionInterface
- stop_rules_processing boolean Required
  
  To stop rule processing
- is_advanced boolean Required
  
  Is this field needed
- product_ids array[integer]
  
  Product ids
- sort_order integer Required
  
  Sort order
- simple_action string
  
  Simple action of the rule
- discount_amount number Required
  
  Discount amount
- discount_qty number
  
  Maximum qty discount is applied
- discount_step integer Required
  
  Discount step
- apply_to_shipping boolean Required
  
  The rule applies to shipping
- times_used integer Required
  
  How many times the rule has been used
- is_rss boolean Required
  
  Whether the rule is in RSS
- coupon_type string Required
  
  Coupon type
- use_auto_generation boolean Required
  
  To auto generate coupon
- uses_per_coupon integer Required
  
  Limit of uses per coupon
- simple_free_shipping string
  
  To grant free shipping
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\SalesRule\Api\Data\RuleInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  reward_points_delta integer
  
  product_groups array[string]
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

POST /V1/salesRules

curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/salesRules' \
 --data '{"rule":{"rule_id":42,"name":"string","store_labels":[{"store_id":42,"store_label":"string","extension_attributes":{}}],"description":"string","website_ids":[42],"customer_group_ids":[42],"from_date":"string","to_date":"string","uses_per_customer":42,"is_active":true,"condition":{"condition_type":"string","conditions":[{}],"aggregator_type":"string","operator":"string","attribute_name":"string","value":"string","extension_attributes":{}},"action_condition":{"condition_type":"string","conditions":[{}],"aggregator_type":"string","operator":"string","attribute_name":"string","value":"string","extension_attributes":{}},"stop_rules_processing":true,"is_advanced":true,"product_ids":[42],"sort_order":42,"simple_action":"string","discount_amount":42.0,"discount_qty":42.0,"discount_step":42,"apply_to_shipping":true,"times_used":42,"is_rss":true,"coupon_type":"string","use_auto_generation":true,"uses_per_coupon":42,"simple_free_shipping":"string","extension_attributes":{"reward_points_delta":42,"product_groups":["string"]}}}'

Request examples

{
  "rule": {
    "rule_id": 42,
    "name": "string",
    "store_labels": [
      {
        "store_id": 42,
        "store_label": "string",
        "extension_attributes": {}
      }
    ],
    "description": "string",
    "website_ids": [
      42
    ],
    "customer_group_ids": [
      42
    ],
    "from_date": "string",
    "to_date": "string",
    "uses_per_customer": 42,
    "is_active": true,
    "condition": {
      "condition_type": "string",
      "conditions": [
        {}
      ],
      "aggregator_type": "string",
      "operator": "string",
      "attribute_name": "string",
      "value": "string",
      "extension_attributes": {}
    },
    "action_condition": {
      "condition_type": "string",
      "conditions": [
        {}
      ],
      "aggregator_type": "string",
      "operator": "string",
      "attribute_name": "string",
      "value": "string",
      "extension_attributes": {}
    },
    "stop_rules_processing": true,
    "is_advanced": true,
    "product_ids": [
      42
    ],
    "sort_order": 42,
    "simple_action": "string",
    "discount_amount": 42.0,
    "discount_qty": 42.0,
    "discount_step": 42,
    "apply_to_shipping": true,
    "times_used": 42,
    "is_rss": true,
    "coupon_type": "string",
    "use_auto_generation": true,
    "uses_per_coupon": 42,
    "simple_free_shipping": "string",
    "extension_attributes": {
      "reward_points_delta": 42,
      "product_groups": [
        "string"
      ]
    }
  }
}

Response examples (200)

{
  "rule_id": 42,
  "name": "string",
  "store_labels": [
    {
      "store_id": 42,
      "store_label": "string",
      "extension_attributes": {}
    }
  ],
  "description": "string",
  "website_ids": [
    42
  ],
  "customer_group_ids": [
    42
  ],
  "from_date": "string",
  "to_date": "string",
  "uses_per_customer": 42,
  "is_active": true,
  "condition": {
    "condition_type": "string",
    "conditions": [
      {}
    ],
    "aggregator_type": "string",
    "operator": "string",
    "attribute_name": "string",
    "value": "string",
    "extension_attributes": {}
  },
  "action_condition": {
    "condition_type": "string",
    "conditions": [
      {}
    ],
    "aggregator_type": "string",
    "operator": "string",
    "attribute_name": "string",
    "value": "string",
    "extension_attributes": {}
  },
  "stop_rules_processing": true,
  "is_advanced": true,
  "product_ids": [
    42
  ],
  "sort_order": 42,
  "simple_action": "string",
  "discount_amount": 42.0,
  "discount_qty": 42.0,
  "discount_step": 42,
  "apply_to_shipping": true,
  "times_used": 42,
  "is_rss": true,
  "coupon_type": "string",
  "use_auto_generation": true,
  "uses_per_coupon": 42,
  "simple_free_shipping": "string",
  "extension_attributes": {
    "reward_points_delta": 42,
    "product_groups": [
      "string"
    ]
  }
}

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"
}

Get payment information

GET /V1/purchase-order-carts/{cartId}/payment-information

Get payment information

Path parameters

cartId integer Required

Responses

200

200 Success.
Hide response attributes Show response attributes object
- payment_methods array[object] Required
  
  Interface PaymentMethodInterface
  
  Interface PaymentMethodInterface
  
  Hide payment_methods attributes Show payment_methods attributes object
  
  code string Required
  
  Payment method code
  
  title string Required
  
  Payment method title
- totals object Required
  
  Interface TotalsInterface
  
  Hide totals attributes Show totals 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
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Checkout\Api\Data\PaymentDetailsInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  adyen_payment_methods_response string
  
  adyen_connected_terminals string
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

GET /V1/purchase-order-carts/{cartId}/payment-information

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

Response examples (200)

{
  "payment_methods": [
    {
      "code": "string",
      "title": "string"
    }
  ],
  "totals": {
    "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
    }
  },
  "extension_attributes": {
    "adyen_payment_methods_response": "string",
    "adyen_connected_terminals": "string"
  }
}

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"
}

Set the gift message for an entire order

POST /V1/carts/mine/gift-message

Set the gift message for an entire order.

Body

giftMessage object Required

Interface MessageInterface
Hide giftMessage attributes Show giftMessage attributes object
- gift_message_id integer
  
  Gift message ID. Otherwise, null.
- customer_id integer
  
  Customer ID. Otherwise, null.
- sender string Required
  
  Sender name.
- recipient string Required
  
  Recipient name.
- message string Required
  
  Message text.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\GiftMessage\Api\Data\MessageInterface
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  entity_id string
  
  entity_type string
  
  wrapping_id integer
  
  wrapping_allow_gift_receipt boolean
  
  wrapping_add_printed_card boolean

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/carts/mine/gift-message

curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/carts/mine/gift-message' \
 --data '{"giftMessage":{"gift_message_id":42,"customer_id":42,"sender":"string","recipient":"string","message":"string","extension_attributes":{"entity_id":"string","entity_type":"string","wrapping_id":42,"wrapping_allow_gift_receipt":true,"wrapping_add_printed_card":true}}}'

Request examples

{
  "giftMessage": {
    "gift_message_id": 42,
    "customer_id": 42,
    "sender": "string",
    "recipient": "string",
    "message": "string",
    "extension_attributes": {
      "entity_id": "string",
      "entity_type": "string",
      "wrapping_id": 42,
      "wrapping_allow_gift_receipt": true,
      "wrapping_add_printed_card": true
    }
  }
}

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"
}

Search for images based on search criteria

GET /V1/adobestock/asset/list

Search for images based on search criteria

Query parameters

searchCriteria[requestName] string
searchCriteria[filterGroups][0][filters][0][field] string

Field
searchCriteria[filterGroups][0][filters][0][value] string

Value
searchCriteria[filterGroups][0][filters][0][conditionType] string

Condition type
searchCriteria[sortOrders][0][field] string

Sorting field.
searchCriteria[sortOrders][0][direction] string

Sorting direction.
searchCriteria[pageSize] integer

Page size.
searchCriteria[currentPage] integer

Current page.

Responses

200

200 Success.
Hide response attributes Show response attributes object
- items array[object] Required
  
  Interface Search Document
  
  Interface Search Document
  
  Hide items attributes Show items attributes object
  
  id integer Required
  
  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
- aggregations object Required
  
  Interface Aggregation to get faceted data
  
  Hide aggregations attributes Show aggregations attributes object
  
  buckets array[object] Required
  
  Interface for facet Bucket
  
  Interface for facet Bucket
  
  Hide buckets attributes Show buckets attributes object
  
  name string Required
  
  Field name
  
  values array[object] Required
  
  Interface Aggregation Value
  
  Interface Aggregation Value
  
  Hide values attributes Show values attributes object
  
  value string Required
  
  Aggregation
  
  metrics array[string] Required
  
  Metrics
  
  bucket_names array[string] Required
  
  Document field names
- search_criteria object Required
  
  Interface SearchCriteriaInterface
  
  Hide search_criteria attributes Show search_criteria attributes object
  
  request_name string Required
  
  filter_groups array[object] Required
  
  Groups two or more filters together using a logical OR
  
  Groups two or more filters together using a logical OR
  
  Hide filter_groups attribute Show filter_groups attribute object
  
  filters array[object]
  
  Filter which can be used by any methods from service layer.
  
  Filter which can be used by any methods from service layer.
  
  Hide filters attributes Show filters attributes object
  
  field string Required
  
  Field
  
  value string Required
  
  Value
  
  condition_type string
  
  Condition type
  
  sort_orders array[object]
  
  Data object for sort order.
  
  Data object for sort order.
  
  Hide sort_orders attributes Show sort_orders attributes object
  
  field string Required
  
  Sorting field.
  
  direction string Required
  
  Sorting direction.
  
  page_size integer
  
  Page size.
  
  current_page integer
  
  Current page.
- total_count integer Required
  
  Total count.
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
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

GET /V1/adobestock/asset/list

curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/adobestock/asset/list'

Response examples (200)

{
  "items": [
    {
      "id": 42,
      "custom_attributes": [
        {
          "attribute_code": "string",
          "value": "string"
        }
      ]
    }
  ],
  "aggregations": {
    "buckets": [
      {
        "name": "string",
        "values": [
          {
            "value": "string",
            "metrics": [
              "string"
            ]
          }
        ]
      }
    ],
    "bucket_names": [
      "string"
    ]
  },
  "search_criteria": {
    "request_name": "string",
    "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
}

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 (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"
}

Comments list

GET /V1/returns/{id}/comments

Comments list

Path parameters

id integer Required

Responses

200

200 Success.
Hide response attributes Show response attributes object
- items array[object] Required
  
  Interface CommentInterface
  
  Interface CommentInterface
  
  Hide items attributes Show items attributes object
  
  comment string Required
  
  Comment
  
  rma_entity_id integer Required
  
  Rma Id
  
  created_at string Required
  
  Created_at
  
  entity_id integer Required
  
  Entity_id
  
  customer_notified boolean Required
  
  Is_customer_notified
  
  visible_on_front boolean Required
  
  Is_visible_on_front
  
  status string Required
  
  Status
  
  admin boolean Required
  
  Is_admin
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\Rma\Api\Data\CommentInterface
  
  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
- search_criteria object Required
  
  Search criteria interface.
  
  Hide search_criteria attributes Show search_criteria attributes object
  
  filter_groups array[object] Required
  
  Groups two or more filters together using a logical OR
  
  Groups two or more filters together using a logical OR
  
  Hide filter_groups attribute Show filter_groups attribute object
  
  filters array[object]
  
  Filter which can be used by any methods from service layer.
  
  Filter which can be used by any methods from service layer.
  
  Hide filters attributes Show filters attributes object
  
  field string Required
  
  Field
  
  value string Required
  
  Value
  
  condition_type string
  
  Condition type
  
  sort_orders array[object]
  
  Data object for sort order.
  
  Data object for sort order.
  
  Hide sort_orders attributes Show sort_orders attributes object
  
  field string Required
  
  Sorting field.
  
  direction string Required
  
  Sorting direction.
  
  page_size integer
  
  Page size.
  
  current_page integer
  
  Current page.
- total_count integer Required
  
  Total count.
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

GET /V1/returns/{id}/comments

curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/returns/{id}/comments'

Response examples (200)

{
  "items": [
    {
      "comment": "string",
      "rma_entity_id": 42,
      "created_at": "string",
      "entity_id": 42,
      "customer_notified": true,
      "visible_on_front": true,
      "status": "string",
      "admin": 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
}

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"
}

Get Apple Pay Config

GET /V1/payments-config/apple-pay/{location}

Get Apple Pay Config.

Path parameters

location string Required

sdk location.

Responses

200

200 Success.
Hide response attributes Show response attributes object
- button_styles object Required
  
  Hide button_styles attributes Show button_styles attributes object
  
  layout string Required
  
  Layout
  
  color string Required
  
  Color
  
  shape string Required
  
  Shape
  
  label string Required
  
  Label
  
  tagline boolean Required
  
  ShowTagline
  
  height integer Required
  
  Height
  
  use_default_height boolean Required
  
  Height
- payment_source string Required
  
  PaymentSource
- code string Required
  
  Code
- sdk_params array[object] Required
  
  Hide sdk_params attributes Show sdk_params attributes object
  
  name string Required
  
  Code
  
  value string Required
  
  Config
- is_visible boolean Required
  
  Visible
- sort_order string Required
  
  Sort Order
- payment_intent string Required
  
  Payment intent
- title string Required
  
  Title
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

GET /V1/payments-config/apple-pay/{location}

curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/payments-config/apple-pay/{location}'

Response examples (200)

{
  "button_styles": {
    "layout": "string",
    "color": "string",
    "shape": "string",
    "label": "string",
    "tagline": true,
    "height": 42,
    "use_default_height": true
  },
  "payment_source": "string",
  "code": "string",
  "sdk_params": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "is_visible": true,
  "sort_order": "string",
  "payment_intent": "string",
  "title": "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"
}

Get Hosted Fields Config

GET /V1/payments-config/hosted-fields/{location}

Get Hosted Fields Config.

Path parameters

location string Required

sdk location.

Responses

200

200 Success.
Hide response attributes Show response attributes object
- payment_source string Required
  
  Payment Source
- three_d_s string Required
  
  ThreeDS
- is_vault_enabled boolean Required
  
  HasIsVaultEnabled
- cc_vault_code string Required
  
  CcVaultCode
- requires_card_details boolean Required
  
  RequiresCardDetails
- code string Required
  
  Code
- sdk_params array[object] Required
  
  Hide sdk_params attributes Show sdk_params attributes object
  
  name string Required
  
  Code
  
  value string Required
  
  Config
- is_visible boolean Required
  
  Visible
- sort_order string Required
  
  Sort Order
- payment_intent string Required
  
  Payment intent
- title string Required
  
  Title
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

GET /V1/payments-config/hosted-fields/{location}

curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/payments-config/hosted-fields/{location}'

Response examples (200)

{
  "payment_source": "string",
  "three_d_s": "string",
  "is_vault_enabled": true,
  "cc_vault_code": "string",
  "requires_card_details": true,
  "code": "string",
  "sdk_params": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "is_visible": true,
  "sort_order": "string",
  "payment_intent": "string",
  "title": "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"
}

Post v1 customers magichash

POST /V1/customers/magic-hash

Body

username string 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

POST /V1/customers/magic-hash

curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/customers/magic-hash' \
 --data '{"username":"string"}'

Request examples

{
  "username": "string"
}

Response examples (200)

string

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"
}

Get v1 winkelstraat productalert stock get

GET /V1/winkelstraat/product-alert/stock/get

Query parameters

sku string 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
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

GET /V1/winkelstraat/product-alert/stock/get

curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/winkelstraat/product-alert/stock/get?sku=string'

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 (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"
}

\WinkelstraatShippingPackedExternalShipmentPackedResetV1 Dismiss highlight

\WinkelstraatShippingPackedExternalShipmentPackedResetV1