Magento B2B
2.4

Base URL 
https://magento2.winkelstraat.mac/rest/all

This is version 2.4 of this API documentation. Last update on Jun 25, 2024.

adobeCommerceEventsClientUpdateConfigurationV1

Updates eventing configuration

eavAttributeSetRepositoryV1

Interface AttributeSetRepositoryInterface

Delete customer group by ID

DELETE /V1/customerGroups/{id}

Delete customer group by ID.

Path parameters

  • id integer Required

Responses

  • 200

    200 Success.

    true on success
  • 401

    401 Unauthorized

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Error details

      Error details

      Hide errors attributes Show errors attributes object
      • message string

        Error message

      • parameters array[object]

        Error parameters item

        Error parameters item

        Hide parameters attributes Show parameters attributes object
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
DELETE /V1/customerGroups/{id} 
curl \
 --request DELETE 'https://magento2.winkelstraat.mac/rest/all/V1/customerGroups/{id}'
Response examples (200) 
true
Response examples (401) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (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"
}

Check if password reset token is valid

GET /V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}

Check if password reset token is valid.

Path parameters

Responses

  • 200

    200 Success.

    True if the token is valid
  • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
GET /V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}'
Response examples (200) 
true
Response examples (400) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (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"
}

Gets the account confirmation status

GET /V1/customers/{customerId}/confirm

Gets the account confirmation status.

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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
GET /V1/customers/{customerId}/confirm 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/customers/{customerId}/confirm'
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 (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"
}

Resend confirmation email

POST /V1/customers/confirm

Resend confirmation email.

Body

Responses

  • 200

    200 Success.

    true on success
  • 401

    401 Unauthorized

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Error details

      Error details

      Hide errors attributes Show errors attributes object
      • message string

        Error message

      • parameters array[object]

        Error parameters item

        Error parameters item

        Hide parameters attributes Show parameters attributes object
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
POST /V1/customers/confirm 
curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/customers/confirm' \
 --data '{"email":"string","websiteId":42,"redirectUrl":"string"}'
Request examples 
{
  "email": "string",
  "websiteId": 42,
  "redirectUrl": "string"
}
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 (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"
}

Retrieve default shipping address for the given customerId

GET /V1/customers/me/shippingAddress

Retrieve default shipping address for the given customerId.

Responses

  • 200

    200 Success.

    Hide response attributes Show response attributes object
  • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
GET /V1/customers/me/shippingAddress 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/customers/me/shippingAddress'
Response examples (200) 
{
  "id": 42,
  "customer_id": 42,
  "region": {
    "region_code": "string",
    "region": "string",
    "region_id": 42,
    "extension_attributes": {}
  },
  "region_id": 42,
  "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",
  "default_shipping": true,
  "default_billing": true,
  "extension_attributes": {},
  "custom_attributes": [
    {
      "attribute_code": "string",
      "value": "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"
}

Retrieve default shipping address for the given customerId

GET /V1/customers/{customerId}/shippingAddress

Retrieve default shipping address for the given customerId.

Responses

  • 200

    200 Success.

    Hide response attributes Show response attributes object
  • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
GET /V1/customers/{customerId}/shippingAddress 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/customers/{customerId}/shippingAddress'
Response examples (200) 
{
  "id": 42,
  "customer_id": 42,
  "region": {
    "region_code": "string",
    "region": "string",
    "region_id": 42,
    "extension_attributes": {}
  },
  "region_id": 42,
  "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",
  "default_shipping": true,
  "default_billing": true,
  "extension_attributes": {},
  "custom_attributes": [
    {
      "attribute_code": "string",
      "value": "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"
}

backendModuleServiceV1

Interface for module service.

Retrieve pages matching the specified criteria

GET /V1/cmsPage/search

Retrieve pages matching the specified criteria.

Responses

  • 200

    200 Success.

    Hide response attributes Show response attributes object
  • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
GET /V1/cmsPage/search 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/cmsPage/search'
Response examples (200) 
{
  "items": [
    {
      "id": 42,
      "identifier": "string",
      "title": "string",
      "page_layout": "string",
      "meta_title": "string",
      "meta_keywords": "string",
      "meta_description": "string",
      "content_heading": "string",
      "content": "string",
      "creation_time": "string",
      "update_time": "string",
      "sort_order": "string",
      "layout_update_xml": "string",
      "custom_theme": "string",
      "custom_root_template": "string",
      "custom_layout_update_xml": "string",
      "custom_theme_from": "string",
      "custom_theme_to": "string",
      "active": true
    }
  ],
  "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 (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"
}

cmsBlockRepositoryV1

CMS block CRUD interface.

Retrieve block

GET /V1/cmsBlock/{blockId}

Retrieve block.

Responses

  • 200

    200 Success.

    Hide response attributes Show response attributes object
  • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
GET /V1/cmsBlock/{blockId} 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/cmsBlock/{blockId}'
Response examples (200) 
{
  "id": 42,
  "identifier": "string",
  "title": "string",
  "content": "string",
  "creation_time": "string",
  "update_time": "string",
  "active": true
}
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"
}

catalogProductRepositoryV1

catalogProductAttributeIsFilterableManagementV1

Intended to allow setting 'is_filterable' property for specific attribute as integer value via REST/SOAP API

Retrieve 'is_filterable' property for specific attribute as integer

GET /V1/products/attributes/{attributeCode}/is-filterable

Retrieve 'is_filterable' property for specific attribute as integer

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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
GET /V1/products/attributes/{attributeCode}/is-filterable 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/products/attributes/{attributeCode}/is-filterable'
Response examples (200) 
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 (400) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (default) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Retrieve list of Attribute Sets

GET /V1/products/attribute-sets/sets/list

Retrieve list of Attribute Sets

Responses

  • 200

    200 Success.

    Hide response attributes Show response attributes object
    • items array[object] Required

      Interface AttributeSetInterface

      Interface AttributeSetInterface

      Hide items attributes Show items attributes object
    • 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
      • sort_orders array[object]

        Data object for sort order.

        Data object for sort order.

        Hide sort_orders attributes Show sort_orders attributes object
      • page_size integer

        Page size.

      • current_page integer

        Current page.

    • total_count integer Required

      Total count.
  • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
GET /V1/products/attribute-sets/sets/list 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/products/attribute-sets/sets/list'
Response examples (200) 
{
  "items": [
    {
      "attribute_set_id": 42,
      "attribute_set_name": "string",
      "sort_order": 42,
      "entity_type_id": 42,
      "extension_attributes": {}
    }
  ],
  "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 (default) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Create attribute set from data

POST /V1/products/attribute-sets

Create attribute set from data

Body

Responses

  • 200

    200 Success.

    Hide response attributes Show response attributes object
  • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
POST /V1/products/attribute-sets 
curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/products/attribute-sets' \
 --data '{"attributeSet":{"attribute_set_id":42,"attribute_set_name":"string","sort_order":42,"entity_type_id":42,"extension_attributes":{}},"skeletonId":42}'
Request examples 
{
  "attributeSet": {
    "attribute_set_id": 42,
    "attribute_set_name": "string",
    "sort_order": 42,
    "entity_type_id": 42,
    "extension_attributes": {}
  },
  "skeletonId": 42
}
Response examples (200) 
{
  "attribute_set_id": 42,
  "attribute_set_name": "string",
  "sort_order": 42,
  "entity_type_id": 42,
  "extension_attributes": {}
}
Response examples (401) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (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"
}

catalogProductAttributeOptionManagementV1

Retrieve list of attribute options

GET /V1/products/attributes/{attributeCode}/options

Retrieve list of attribute options

Responses

  • 200

    200 Success.

    Hide response attributes Show response 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
  • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
GET /V1/products/attributes/{attributeCode}/options 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/products/attributes/{attributeCode}/options'
Response examples (200) 
[
  {
    "label": "string",
    "value": "string",
    "sort_order": 42,
    "is_default": true,
    "store_labels": [
      {
        "store_id": 42,
        "label": "string"
      }
    ]
  }
]
Response examples (400) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (default) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Retrieve the list of media attributes

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

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

Responses

GET /V1/products/media/types/{attributeSetName} 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/products/media/types/{attributeSetName}'
Response examples (200) 
[
  {
    "extension_attributes": {
      "is_pagebuilder_enabled": true
    },
    "is_wysiwyg_enabled": true,
    "is_html_allowed_on_front": true,
    "used_for_sort_by": true,
    "is_filterable": true,
    "is_filterable_in_search": true,
    "is_used_in_grid": true,
    "is_visible_in_grid": true,
    "is_filterable_in_grid": true,
    "position": 42,
    "apply_to": [
      "string"
    ],
    "is_searchable": "string",
    "is_visible_in_advanced_search": "string",
    "is_comparable": "string",
    "is_used_for_promo_rules": "string",
    "is_visible_on_front": "string",
    "used_in_product_listing": "string",
    "is_visible": true,
    "scope": "string",
    "attribute_id": 42,
    "attribute_code": "string",
    "frontend_input": "string",
    "entity_type_id": "string",
    "is_required": true,
    "options": [
      {
        "label": "string",
        "value": "string",
        "sort_order": 42,
        "is_default": true,
        "store_labels": [
          {
            "store_id": 42,
            "label": "string"
          }
        ]
      }
    ],
    "is_user_defined": true,
    "default_frontend_label": "string",
    "frontend_labels": [
      {
        "store_id": 42,
        "label": "string"
      }
    ],
    "note": "string",
    "backend_type": "string",
    "backend_model": "string",
    "source_model": "string",
    "default_value": "string",
    "is_unique": "string",
    "frontend_class": "string",
    "validation_rules": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "custom_attributes": [
      {
        "attribute_code": "string",
        "value": "string"
      }
    ]
  }
]
Response examples (default) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Add

POST /V1/products/base-prices

Add or update product prices. Input item should correspond \Magento\Catalog\Api\Data\CostInterface. If any items will have invalid price, store id or sku, they will be marked as failed and excluded from update list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the update exception will be thrown.

Body

  • prices array[object] Required

    Price interface.

    Price interface.

    Hide prices attributes Show prices attributes object

Responses

  • 200

    200 Success.

    Hide response attributes Show response attributes object
    • message string Required

      Error message, that contains description of error occurred during price update.

    • parameters array[string] Required

      Parameters, that could be displayed in error message placeholders.

    • extension_attributes object

      ExtensionInterface class for @see \Magento\Catalog\Api\Data\PriceUpdateResultInterface
  • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
POST /V1/products/base-prices 
curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/products/base-prices' \
 --data '{"prices":[{"price":42.0,"store_id":42,"sku":"string","extension_attributes":{}}]}'
Request examples 
{
  "prices": [
    {
      "price": 42.0,
      "store_id": 42,
      "sku": "string",
      "extension_attributes": {}
    }
  ]
}
Response examples (200) 
[
  {
    "message": "string",
    "parameters": [
      "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"
}

Add

POST /V1/products/special-price

Add or update product's special price. If any items will have invalid price, store id, sku or dates, they will be marked as failed and excluded from update list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] with problem description will be returned. If there were no failed items during update empty array will be returned. If error occurred during the update exception will be thrown.

Body

  • prices array[object] Required

    Product Special Price Interface is used to encapsulate data that can be processed by efficient price API.

    Product Special Price Interface is used to encapsulate data that can be processed by efficient price API.

    Hide prices attributes Show prices attributes object
    • price number Required

      Product special price value.

    • store_id integer Required

      ID of store, that contains special price value.

    • sku string Required

      SKU of product, that contains special price value.

    • price_from string Required

      Start date for special price in Y-m-d H:i:s format.

    • price_to string Required

      End date for special price in Y-m-d H:i:s format.

    • extension_attributes object

      ExtensionInterface class for @see \Magento\Catalog\Api\Data\SpecialPriceInterface

Responses

  • 200

    200 Success.

    Hide response attributes Show response attributes object
    • message string Required

      Error message, that contains description of error occurred during price update.

    • parameters array[string] Required

      Parameters, that could be displayed in error message placeholders.

    • extension_attributes object

      ExtensionInterface class for @see \Magento\Catalog\Api\Data\PriceUpdateResultInterface
  • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
POST /V1/products/special-price 
curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/products/special-price' \
 --data '{"prices":[{"price":42.0,"store_id":42,"sku":"string","price_from":"string","price_to":"string","extension_attributes":{}}]}'
Request examples 
{
  "prices": [
    {
      "price": 42.0,
      "store_id": 42,
      "sku": "string",
      "price_from": "string",
      "price_to": "string",
      "extension_attributes": {}
    }
  ]
}
Response examples (200) 
[
  {
    "message": "string",
    "parameters": [
      "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"
}

Get the list of custom options for a specific product

GET /V1/products/{sku}/options

Get the list of custom options for a specific product

Path parameters

Responses

GET /V1/products/{sku}/options 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/products/{sku}/options'
Response examples (200) 
[
  {
    "product_sku": "string",
    "option_id": 42,
    "title": "string",
    "type": "string",
    "sort_order": 42,
    "is_require": true,
    "price": 42.0,
    "price_type": "string",
    "sku": "string",
    "file_extension": "string",
    "max_characters": 42,
    "image_size_x": 42,
    "image_size_y": 42,
    "values": [
      {
        "title": "string",
        "sort_order": 42,
        "price": 42.0,
        "price_type": "string",
        "sku": "string",
        "option_type_id": 42
      }
    ],
    "extension_attributes": {}
  }
]
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"
}

Provide a list of the product link type attributes

GET /V1/products/links/{type}/attributes

Provide a list of the product link type attributes

Responses

  • 200

    200 Success.

    Hide response attributes Show response attributes object
    • code string Required

      Attribute code

    • type string Required

      Attribute type

    • extension_attributes object

      ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductLinkAttributeInterface
  • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
GET /V1/products/links/{type}/attributes 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/products/links/{type}/attributes'
Response examples (200) 
[
  {
    "code": "string",
    "type": "string",
    "extension_attributes": {}
  }
]
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"
}

quoteGuestCartManagementV1

Cart Management interface for guest carts.

Estimate shipping

POST /V1/carts/mine/estimate-shipping-methods-by-address-id

Estimate shipping

Body

Responses

POST /V1/carts/mine/estimate-shipping-methods-by-address-id 
curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/carts/mine/estimate-shipping-methods-by-address-id' \
 --data '{"addressId":42}'
Request examples 
{
  "addressId": 42
}
Response examples (200) 
[
  {
    "carrier_code": "string",
    "method_code": "string",
    "carrier_title": "string",
    "method_title": "string",
    "amount": 42.0,
    "base_amount": 42.0,
    "available": true,
    "extension_attributes": {
      "carrier_codes": [
        {
          "code": "string",
          "name": "string"
        }
      ],
      "delivery_window_dates": [
        {
          "carrier_code": "string",
          "from": "string",
          "to": "string",
          "method_title": "string",
          "expires": "string"
        }
      ],
      "is_pickup_point": true,
      "pickup_point": {
        "pick_up_point_id": "string",
        "carrier_method": "string",
        "name": "string",
        "address_lines": [
          "string"
        ],
        "city": "string",
        "state": "string",
        "country": "string",
        "postal": "string",
        "telephone": "string",
        "fax": "string"
      }
    },
    "error_message": "string",
    "price_excl_tax": 42.0,
    "price_incl_tax": 42.0
  }
]
Response examples (401) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (default) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

List applicable shipping methods for a specified quote

GET /V1/guest-carts/{cartId}/shipping-methods

List applicable shipping methods for a specified quote.

Path parameters

  • cartId string Required

    The shopping cart ID.

Responses

GET /V1/guest-carts/{cartId}/shipping-methods 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/guest-carts/{cartId}/shipping-methods'
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 (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/guest-carts/{cartId}/estimate-shipping-methods

Estimate shipping by address and return list of available shipping methods

Body

Responses

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

quoteCartItemRepositoryV1

Interface CartItemRepositoryInterface

Lists items that are assigned to a specified cart

GET /V1/carts/mine/items

Lists items that are assigned to a specified cart.

Responses

GET /V1/carts/mine/items 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/carts/mine/items'
Response examples (200) 
[
  {
    "item_id": 42,
    "sku": "string",
    "qty": 42.0,
    "name": "string",
    "price": 42.0,
    "product_type": "string",
    "quote_id": "string",
    "product_option": {
      "extension_attributes": {
        "custom_options": [
          {
            "option_id": "string",
            "option_value": "string",
            "extension_attributes": {
              "file_info": {
                "base64_encoded_data": "string",
                "type": "string",
                "name": "string"
              }
            }
          }
        ],
        "bundle_options": [
          {
            "option_id": 42,
            "option_qty": 42,
            "option_selections": [
              42
            ],
            "extension_attributes": {}
          }
        ],
        "downloadable_option": {
          "downloadable_links": [
            42
          ]
        },
        "giftcard_item_option": {
          "giftcard_amount": "string",
          "custom_giftcard_amount": 42.0,
          "giftcard_sender_name": "string",
          "giftcard_recipient_name": "string",
          "giftcard_sender_email": "string",
          "giftcard_recipient_email": "string",
          "giftcard_message": "string",
          "extension_attributes": {
            "giftcard_created_codes": [
              "string"
            ]
          }
        },
        "configurable_item_options": [
          {
            "option_id": "string",
            "option_value": "string",
            "extension_attributes": {}
          }
        ],
        "grouped_options": [
          {
            "id": 42,
            "qty": 42,
            "extension_attributes": {}
          }
        ]
      }
    },
    "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
        }
      ],
      "negotiable_quote_item": {
        "item_id": 42,
        "original_price": 42.0,
        "original_tax_amount": 42.0,
        "original_discount_amount": 42.0,
        "extension_attributes": {
          "negotiated_price_type": 42,
          "negotiated_price_value": 42.0,
          "last_item_notes": [
            {
              "note_id": 42,
              "negotiable_quote_item_id": 42,
              "creator_type": 42,
              "creator_id": 42,
              "note": "string",
              "created_at": "string",
              "extension_attributes": {}
            }
          ]
        }
      },
      "size": "string",
      "color": "string",
      "merchant_product_reference": "string",
      "category_code": "string",
      "image": "string",
      "mpn": "string",
      "msrp": 42.0,
      "manufacturer_code": "string",
      "manufacturer_name": "string",
      "merchant_code": "string",
      "merchant_name": "string",
      "merchant_city": "string",
      "parent_sku": "string",
      "is_sale": true,
      "return_item_fee": 42.0,
      "base_return_item_fee": 42.0,
      "is_outlet": 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"
}

List items that are assigned to a specified cart

GET /V1/guest-carts/{cartId}/items

List items that are assigned to a specified cart.

Path parameters

Responses

GET /V1/guest-carts/{cartId}/items 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/guest-carts/{cartId}/items'
Response examples (200) 
[
  {
    "item_id": 42,
    "sku": "string",
    "qty": 42.0,
    "name": "string",
    "price": 42.0,
    "product_type": "string",
    "quote_id": "string",
    "product_option": {
      "extension_attributes": {
        "custom_options": [
          {
            "option_id": "string",
            "option_value": "string",
            "extension_attributes": {
              "file_info": {
                "base64_encoded_data": "string",
                "type": "string",
                "name": "string"
              }
            }
          }
        ],
        "bundle_options": [
          {
            "option_id": 42,
            "option_qty": 42,
            "option_selections": [
              42
            ],
            "extension_attributes": {}
          }
        ],
        "downloadable_option": {
          "downloadable_links": [
            42
          ]
        },
        "giftcard_item_option": {
          "giftcard_amount": "string",
          "custom_giftcard_amount": 42.0,
          "giftcard_sender_name": "string",
          "giftcard_recipient_name": "string",
          "giftcard_sender_email": "string",
          "giftcard_recipient_email": "string",
          "giftcard_message": "string",
          "extension_attributes": {
            "giftcard_created_codes": [
              "string"
            ]
          }
        },
        "configurable_item_options": [
          {
            "option_id": "string",
            "option_value": "string",
            "extension_attributes": {}
          }
        ],
        "grouped_options": [
          {
            "id": 42,
            "qty": 42,
            "extension_attributes": {}
          }
        ]
      }
    },
    "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
        }
      ],
      "negotiable_quote_item": {
        "item_id": 42,
        "original_price": 42.0,
        "original_tax_amount": 42.0,
        "original_discount_amount": 42.0,
        "extension_attributes": {
          "negotiated_price_type": 42,
          "negotiated_price_value": 42.0,
          "last_item_notes": [
            {
              "note_id": 42,
              "negotiable_quote_item_id": 42,
              "creator_type": 42,
              "creator_id": 42,
              "note": "string",
              "created_at": "string",
              "extension_attributes": {}
            }
          ]
        }
      },
      "size": "string",
      "color": "string",
      "merchant_product_reference": "string",
      "category_code": "string",
      "image": "string",
      "mpn": "string",
      "msrp": 42.0,
      "manufacturer_code": "string",
      "manufacturer_name": "string",
      "merchant_code": "string",
      "merchant_name": "string",
      "merchant_city": "string",
      "parent_sku": "string",
      "is_sale": true,
      "return_item_fee": 42.0,
      "base_return_item_fee": 42.0,
      "is_outlet": true
    }
  }
]
Response examples (400) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (default) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Add/update the specified cart item

POST /V1/guest-carts/{cartId}/items

Add/update the specified cart item.

Body

Responses

POST /V1/guest-carts/{cartId}/items 
curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/guest-carts/{cartId}/items' \
 --data '{"cartItem":{"item_id":42,"sku":"string","qty":42.0,"name":"string","price":42.0,"product_type":"string","quote_id":"string","product_option":{"extension_attributes":{"custom_options":[{"option_id":"string","option_value":"string","extension_attributes":{"file_info":{"base64_encoded_data":"string","type":"string","name":"string"}}}],"bundle_options":[{"option_id":42,"option_qty":42,"option_selections":[42],"extension_attributes":{}}],"downloadable_option":{"downloadable_links":[42]},"giftcard_item_option":{"giftcard_amount":"string","custom_giftcard_amount":42.0,"giftcard_sender_name":"string","giftcard_recipient_name":"string","giftcard_sender_email":"string","giftcard_recipient_email":"string","giftcard_message":"string","extension_attributes":{"giftcard_created_codes":["string"]}},"configurable_item_options":[{"option_id":"string","option_value":"string","extension_attributes":{}}],"grouped_options":[{"id":42,"qty":42,"extension_attributes":{}}]}},"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}],"negotiable_quote_item":{"item_id":42,"original_price":42.0,"original_tax_amount":42.0,"original_discount_amount":42.0,"extension_attributes":{"negotiated_price_type":42,"negotiated_price_value":42.0,"last_item_notes":[{"note_id":42,"negotiable_quote_item_id":42,"creator_type":42,"creator_id":42,"note":"string","created_at":"string","extension_attributes":{}}]}},"size":"string","color":"string","merchant_product_reference":"string","category_code":"string","image":"string","mpn":"string","msrp":42.0,"manufacturer_code":"string","manufacturer_name":"string","merchant_code":"string","merchant_name":"string","merchant_city":"string","parent_sku":"string","is_sale":true,"return_item_fee":42.0,"base_return_item_fee":42.0,"is_outlet":true}}}'
Request examples 
{
  "cartItem": {
    "item_id": 42,
    "sku": "string",
    "qty": 42.0,
    "name": "string",
    "price": 42.0,
    "product_type": "string",
    "quote_id": "string",
    "product_option": {
      "extension_attributes": {
        "custom_options": [
          {
            "option_id": "string",
            "option_value": "string",
            "extension_attributes": {
              "file_info": {
                "base64_encoded_data": "string",
                "type": "string",
                "name": "string"
              }
            }
          }
        ],
        "bundle_options": [
          {
            "option_id": 42,
            "option_qty": 42,
            "option_selections": [
              42
            ],
            "extension_attributes": {}
          }
        ],
        "downloadable_option": {
          "downloadable_links": [
            42
          ]
        },
        "giftcard_item_option": {
          "giftcard_amount": "string",
          "custom_giftcard_amount": 42.0,
          "giftcard_sender_name": "string",
          "giftcard_recipient_name": "string",
          "giftcard_sender_email": "string",
          "giftcard_recipient_email": "string",
          "giftcard_message": "string",
          "extension_attributes": {
            "giftcard_created_codes": [
              "string"
            ]
          }
        },
        "configurable_item_options": [
          {
            "option_id": "string",
            "option_value": "string",
            "extension_attributes": {}
          }
        ],
        "grouped_options": [
          {
            "id": 42,
            "qty": 42,
            "extension_attributes": {}
          }
        ]
      }
    },
    "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
        }
      ],
      "negotiable_quote_item": {
        "item_id": 42,
        "original_price": 42.0,
        "original_tax_amount": 42.0,
        "original_discount_amount": 42.0,
        "extension_attributes": {
          "negotiated_price_type": 42,
          "negotiated_price_value": 42.0,
          "last_item_notes": [
            {
              "note_id": 42,
              "negotiable_quote_item_id": 42,
              "creator_type": 42,
              "creator_id": 42,
              "note": "string",
              "created_at": "string",
              "extension_attributes": {}
            }
          ]
        }
      },
      "size": "string",
      "color": "string",
      "merchant_product_reference": "string",
      "category_code": "string",
      "image": "string",
      "mpn": "string",
      "msrp": 42.0,
      "manufacturer_code": "string",
      "manufacturer_name": "string",
      "merchant_code": "string",
      "merchant_name": "string",
      "merchant_city": "string",
      "parent_sku": "string",
      "is_sale": true,
      "return_item_fee": 42.0,
      "base_return_item_fee": 42.0,
      "is_outlet": true
    }
  }
}
Response examples (200) 
{
  "item_id": 42,
  "sku": "string",
  "qty": 42.0,
  "name": "string",
  "price": 42.0,
  "product_type": "string",
  "quote_id": "string",
  "product_option": {
    "extension_attributes": {
      "custom_options": [
        {
          "option_id": "string",
          "option_value": "string",
          "extension_attributes": {
            "file_info": {
              "base64_encoded_data": "string",
              "type": "string",
              "name": "string"
            }
          }
        }
      ],
      "bundle_options": [
        {
          "option_id": 42,
          "option_qty": 42,
          "option_selections": [
            42
          ],
          "extension_attributes": {}
        }
      ],
      "downloadable_option": {
        "downloadable_links": [
          42
        ]
      },
      "giftcard_item_option": {
        "giftcard_amount": "string",
        "custom_giftcard_amount": 42.0,
        "giftcard_sender_name": "string",
        "giftcard_recipient_name": "string",
        "giftcard_sender_email": "string",
        "giftcard_recipient_email": "string",
        "giftcard_message": "string",
        "extension_attributes": {
          "giftcard_created_codes": [
            "string"
          ]
        }
      },
      "configurable_item_options": [
        {
          "option_id": "string",
          "option_value": "string",
          "extension_attributes": {}
        }
      ],
      "grouped_options": [
        {
          "id": 42,
          "qty": 42,
          "extension_attributes": {}
        }
      ]
    }
  },
  "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
      }
    ],
    "negotiable_quote_item": {
      "item_id": 42,
      "original_price": 42.0,
      "original_tax_amount": 42.0,
      "original_discount_amount": 42.0,
      "extension_attributes": {
        "negotiated_price_type": 42,
        "negotiated_price_value": 42.0,
        "last_item_notes": [
          {
            "note_id": 42,
            "negotiable_quote_item_id": 42,
            "creator_type": 42,
            "creator_id": 42,
            "note": "string",
            "created_at": "string",
            "extension_attributes": {}
          }
        ]
      }
    },
    "size": "string",
    "color": "string",
    "merchant_product_reference": "string",
    "category_code": "string",
    "image": "string",
    "mpn": "string",
    "msrp": 42.0,
    "manufacturer_code": "string",
    "manufacturer_name": "string",
    "merchant_code": "string",
    "merchant_name": "string",
    "merchant_city": "string",
    "parent_sku": "string",
    "is_sale": true,
    "return_item_fee": 42.0,
    "base_return_item_fee": 42.0,
    "is_outlet": true
  }
}
Response examples (400) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (default) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Returns the payment method for a specified shopping cart

GET /V1/carts/{cartId}/selected-payment-method

Returns the payment method for a specified shopping cart.

Path parameters

Responses

  • 200

    200 Success.

    Hide response attributes Show response attributes object
  • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
GET /V1/carts/{cartId}/selected-payment-method 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/carts/{cartId}/selected-payment-method'
Response examples (200) 
{
  "po_number": "string",
  "method": "string",
  "additional_data": [
    "string"
  ],
  "extension_attributes": {
    "agreement_ids": [
      "string"
    ],
    "origin": "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"
}

Deletes a coupon from a specified cart

DELETE /V1/carts/{cartId}/coupons

Deletes a coupon from a specified cart.

Path parameters

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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
DELETE /V1/carts/{cartId}/coupons 
curl \
 --request DELETE 'https://magento2.winkelstraat.mac/rest/all/V1/carts/{cartId}/coupons'
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"
}

Adds a coupon by code to a specified cart

PUT /V1/carts/{cartId}/coupons/{couponCode}

Adds a coupon by code to a specified cart.

Path parameters

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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
PUT /V1/carts/{cartId}/coupons/{couponCode} 
curl \
 --request PUT 'https://magento2.winkelstraat.mac/rest/all/V1/carts/{cartId}/coupons/{couponCode}'
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"
}

Cancels a specified order

POST /V1/orders/{id}/cancel

Cancels a specified order.

Path parameters

  • id integer Required

    The order ID.

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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
POST /V1/orders/{id}/cancel 
curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/orders/{id}/cancel'
Response examples (200) 
true
Response examples (401) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (default) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

salesOrderAddressRepositoryV1

Order address repository interface. An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as a purchase order, is emailed to the customer.

salesOrderItemRepositoryV1

Order item repository interface. An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as a purchase order, is emailed to the customer.

Voids a specified invoice

POST /V1/invoices/{id}/void

Voids a specified invoice.

Path parameters

  • id integer Required

    The invoice ID.

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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
POST /V1/invoices/{id}/void 
curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/invoices/{id}/void'
Response examples (200) 
true
Response examples (401) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (default) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

salesCreditmemoManagementV1

Credit memo add comment interface. After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the customer account so that the customer can make future purchases.

salesShipOrderV1

Class ShipOrderInterface

salesRuleRuleRepositoryV1

Sales rule CRUD interface

bundleProductLinkManagementV1

Interface for Management of ProductLink

bundleProductOptionTypeListV1

Interface ProductOptionTypeListInterface

Add new option for bundle product

PUT /V1/bundle-products/options/{optionId}

Add new option for bundle product

Body

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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
PUT /V1/bundle-products/options/{optionId} 
curl \
 --request PUT 'https://magento2.winkelstraat.mac/rest/all/V1/bundle-products/options/{optionId}' \
 --data '{"option":{"option_id":42,"title":"string","required":true,"type":"string","position":42,"sku":"string","product_links":[{"id":"string","sku":"string","option_id":42,"qty":42.0,"position":42,"is_default":true,"price":42.0,"price_type":42,"can_change_quantity":42,"extension_attributes":{}}],"extension_attributes":{}}}'
Request examples 
{
  "option": {
    "option_id": 42,
    "title": "string",
    "required": true,
    "type": "string",
    "position": 42,
    "sku": "string",
    "product_links": [
      {
        "id": "string",
        "sku": "string",
        "option_id": 42,
        "qty": 42.0,
        "position": 42,
        "is_default": true,
        "price": 42.0,
        "price_type": 42,
        "can_change_quantity": 42,
        "extension_attributes": {}
      }
    ],
    "extension_attributes": {}
  }
}
Response examples (200) 
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 (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"
}

Put v1 products product sku stock items item

PUT /V1/products/{productSku}/stockItems/{itemId}

Path parameters

Body

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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
PUT /V1/products/{productSku}/stockItems/{itemId} 
curl \
 --request PUT 'https://magento2.winkelstraat.mac/rest/all/V1/products/{productSku}/stockItems/{itemId}' \
 --data '{"stockItem":{"item_id":42,"product_id":42,"stock_id":42,"qty":42.0,"is_in_stock":true,"is_qty_decimal":true,"show_default_notification_message":true,"use_config_min_qty":true,"min_qty":42.0,"use_config_min_sale_qty":42,"min_sale_qty":42.0,"use_config_max_sale_qty":true,"max_sale_qty":42.0,"use_config_backorders":true,"backorders":42,"use_config_notify_stock_qty":true,"notify_stock_qty":42.0,"use_config_qty_increments":true,"qty_increments":42.0,"use_config_enable_qty_inc":true,"enable_qty_increments":true,"use_config_manage_stock":true,"manage_stock":true,"low_stock_date":"string","is_decimal_divided":true,"stock_status_changed_auto":42,"extension_attributes":{}}}'
Request examples 
{
  "stockItem": {
    "item_id": 42,
    "product_id": 42,
    "stock_id": 42,
    "qty": 42.0,
    "is_in_stock": true,
    "is_qty_decimal": true,
    "show_default_notification_message": true,
    "use_config_min_qty": true,
    "min_qty": 42.0,
    "use_config_min_sale_qty": 42,
    "min_sale_qty": 42.0,
    "use_config_max_sale_qty": true,
    "max_sale_qty": 42.0,
    "use_config_backorders": true,
    "backorders": 42,
    "use_config_notify_stock_qty": true,
    "notify_stock_qty": 42.0,
    "use_config_qty_increments": true,
    "qty_increments": 42.0,
    "use_config_enable_qty_inc": true,
    "enable_qty_increments": true,
    "use_config_manage_stock": true,
    "manage_stock": true,
    "low_stock_date": "string",
    "is_decimal_divided": true,
    "stock_status_changed_auto": 42,
    "extension_attributes": {}
  }
}
Response examples (200) 
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 (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"
}

searchV1

Search API for all requests

Get payment information

GET /V1/guest-carts/{cartId}/payment-information

Get payment information

Responses

GET /V1/guest-carts/{cartId}/payment-information 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/guest-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 (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/carts/mine/payment-information

Get payment information

Responses

GET /V1/carts/mine/payment-information 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/carts/mine/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 payment information for a specified cart

POST /V1/purchase-order-carts/{cartId}/set-payment-information

Set payment information for a specified cart.

Body

Responses

  • 200

    200 Success.

    Order ID.
  • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
POST /V1/purchase-order-carts/{cartId}/set-payment-information 
curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/purchase-order-carts/{cartId}/set-payment-information' \
 --data '{"paymentMethod":{"po_number":"string","method":"string","additional_data":["string"],"extension_attributes":{"agreement_ids":["string"],"origin":"string"}},"billingAddress":{"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 
{
  "paymentMethod": {
    "po_number": "string",
    "method": "string",
    "additional_data": [
      "string"
    ],
    "extension_attributes": {
      "agreement_ids": [
        "string"
      ],
      "origin": "string"
    }
  },
  "billingAddress": {
    "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) 
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 (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"
}

integrationCustomerTokenServiceV1

Interface providing token generation for Customers

List of links with associated samples

GET /V1/products/{sku}/downloadable-links

List of links with associated samples

GET /V1/products/{sku}/downloadable-links 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/products/{sku}/downloadable-links'
Response examples (200) 
[
  {
    "id": 42,
    "title": "string",
    "sort_order": 42,
    "is_shareable": 42,
    "price": 42.0,
    "number_of_downloads": 42,
    "link_type": "string",
    "link_file": "string",
    "link_file_content": {
      "file_data": "string",
      "name": "string",
      "extension_attributes": {}
    },
    "link_url": "string",
    "sample_type": "string",
    "sample_file": "string",
    "sample_file_content": {
      "file_data": "string",
      "name": "string",
      "extension_attributes": {}
    },
    "sample_url": "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 (default) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

configurableProductOptionRepositoryV1

Manage options of configurable product

giftRegistryShippingMethodManagementV1

Interface ShippingMethodManagementInterface

giftRegistryGuestCartShippingMethodManagementV1

Interface ShippingMethodManagementInterface

companyCompanyRepositoryV1

A repository interface for company entity that provides basic CRUD operations.

companyTeamRepositoryV1

Interface for basic CRUD operations for team entity.

Create a team in the company structure

POST /V1/team/{companyId}

Create a team in the company structure.

Body

  • team object Required

    Team interface

    Hide team attributes Show team attributes object

Responses

  • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
POST /V1/team/{companyId} 
curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/team/{companyId}' \
 --data '{"team":{"id":42,"name":"string","description":"string","extension_attributes":{},"custom_attributes":[{"attribute_code":"string","value":"string"}]}}'
Request examples 
{
  "team": {
    "id": 42,
    "name": "string",
    "description": "string",
    "extension_attributes": {},
    "custom_attributes": [
      {
        "attribute_code": "string",
        "value": "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"
}

Moves teams and users within the company structure

PUT /V1/hierarchy/move/{id}

Moves teams and users within the company structure.

Path parameters

  • id integer Required

Body

Responses

  • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
PUT /V1/hierarchy/move/{id} 
curl \
 --request PUT 'https://magento2.winkelstraat.mac/rest/all/V1/hierarchy/move/{id}' \
 --data '{"newParentId":42}'
Request examples 
{
  "newParentId": 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"
}

Save TaxRule

POST /V1/taxRules

Save TaxRule

Body

Responses

  • 200

    200 Success.

    Hide response attributes Show response attributes object
  • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
POST /V1/taxRules 
curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/taxRules' \
 --data '{"rule":{"id":42,"code":"string","priority":42,"position":42,"customer_tax_class_ids":[42],"product_tax_class_ids":[42],"tax_rate_ids":[42],"calculate_subtotal":true,"extension_attributes":{}}}'
Request examples 
{
  "rule": {
    "id": 42,
    "code": "string",
    "priority": 42,
    "position": 42,
    "customer_tax_class_ids": [
      42
    ],
    "product_tax_class_ids": [
      42
    ],
    "tax_rate_ids": [
      42
    ],
    "calculate_subtotal": true,
    "extension_attributes": {}
  }
}
Response examples (200) 
{
  "id": 42,
  "code": "string",
  "priority": 42,
  "position": 42,
  "customer_tax_class_ids": [
    42
  ],
  "product_tax_class_ids": [
    42
  ],
  "tax_rate_ids": [
    42
  ],
  "calculate_subtotal": true,
  "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 (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"
}

Returns data on the credit limit for a specified credit limit ID

GET /V1/companyCredits/{creditId}

Returns data on the credit limit for a specified credit limit ID.

Query parameters

Responses

  • 200

    200 Success.

    Hide response attributes Show response attributes object
  • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
GET /V1/companyCredits/{creditId} 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/companyCredits/{creditId}'
Response examples (200) 
{
  "id": 42,
  "company_id": 42,
  "credit_limit": 42.0,
  "balance": 42.0,
  "currency_code": "string",
  "exceed_limit": true,
  "available_limit": 42.0,
  "credit_comment": "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"
}

twoFactorAuthTfatActionsV1

Actions the user can perform using the pre-2fa token (tfat)

Authenticate using the present one touch response and get an admin token

POST /V1/tfa/provider/authy/authenticate-onetouch

Authenticate using the present one touch response and get an admin token

Body

Responses

  • 200

    200 Success.
  • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
POST /V1/tfa/provider/authy/authenticate-onetouch 
curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/tfa/provider/authy/authenticate-onetouch' \
 --data '{"username":"string","password":"string"}'
Request examples 
{
  "username": "string",
  "password": "string"
}
Response examples (200) 
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"
}

twoFactorAuthDuoConfigureV1

Represents configuration for the duo security provider

negotiableQuoteShipmentEstimationV1

Interface ShipmentManagementInterface

negotiableQuoteCouponManagementV1

Coupon management service interface.

Return the following properties for the selected shared catalog: ID

GET /V1/sharedCatalog/{sharedCatalogId}

Return the following properties for the selected shared catalog: ID, Store Group ID, Name, Type, Description, Customer Group, Tax Class.

Responses

  • 200

    200 Success.

    Hide response attributes Show response attributes object
  • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
GET /V1/sharedCatalog/{sharedCatalogId} 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/sharedCatalog/{sharedCatalogId}'
Response examples (200) 
{
  "id": 42,
  "name": "string",
  "description": "string",
  "customer_group_id": 42,
  "type": 42,
  "created_at": "string",
  "created_by": 42,
  "store_id": 42,
  "tax_class_id": 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 (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"
}

inventoryApiStockSourceLinksDeleteV1

Service method for stock source links delete multiple Performance efficient API Used fully qualified namespaces in annotations for proper work of WebApi request parser

inventoryCatalogApiBulkSourceUnassignV1

Perform bulk product source un-assignment

Delete RMA

DELETE /V1/returns/{id}

Delete RMA

Path parameters

  • id string Required

Body

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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • 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
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
DELETE /V1/returns/{id} 
curl \
 --request DELETE 'https://magento2.winkelstraat.mac/rest/all/V1/returns/{id}' \
 --data '{"rmaDataObject":{"increment_id":"string","entity_id":42,"order_id":42,"order_increment_id":"string","store_id":42,"customer_id":42,"date_requested":"string","customer_custom_email":"string","items":[{"entity_id":42,"rma_entity_id":42,"order_item_id":42,"qty_requested":42,"qty_authorized":42,"qty_approved":42,"qty_returned":42,"reason":"string","condition":"string","resolution":"string","status":"string","extension_attributes":{"merchant_resolution_code":"string","reason_code":"string","resolution_code":"string","product_color":"string","product_size":"string","product_merchant_code":"string","product_merchant_name":"string","product_merchant_product_reference":"string","product_manufacturer_code":"string","product_manufacturer_name":"string","exchange_size":"string"}}],"status":"string","comments":[{"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"}]}],"tracks":[{"entity_id":42,"rma_entity_id":42,"track_number":"string","carrier_title":"string","carrier_code":"string","extension_attributes":{"status":"string","delivery_time":"string","external_updated_at":"string","label_filename":"string"}}],"extension_attributes":{"rma_return_address":{"rma_id":42,"name":"string","street":"string","city":"string","country_id":"string","postcode":"string","telephone":"string","email":"string"},"merchant_code":"string","date_received":"string","customer_firstname":"string","customer_lastname":"string","date_processed":"string","shipping_address_customer_firstname":"string","shipping_address_customer_lastname":"string"},"custom_attributes":[{"attribute_code":"string","value":"string"}]}}'
Request examples 
{
  "rmaDataObject": {
    "increment_id": "string",
    "entity_id": 42,
    "order_id": 42,
    "order_increment_id": "string",
    "store_id": 42,
    "customer_id": 42,
    "date_requested": "string",
    "customer_custom_email": "string",
    "items": [
      {
        "entity_id": 42,
        "rma_entity_id": 42,
        "order_item_id": 42,
        "qty_requested": 42,
        "qty_authorized": 42,
        "qty_approved": 42,
        "qty_returned": 42,
        "reason": "string",
        "condition": "string",
        "resolution": "string",
        "status": "string",
        "extension_attributes": {
          "merchant_resolution_code": "string",
          "reason_code": "string",
          "resolution_code": "string",
          "product_color": "string",
          "product_size": "string",
          "product_merchant_code": "string",
          "product_merchant_name": "string",
          "product_merchant_product_reference": "string",
          "product_manufacturer_code": "string",
          "product_manufacturer_name": "string",
          "exchange_size": "string"
        }
      }
    ],
    "status": "string",
    "comments": [
      {
        "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"
          }
        ]
      }
    ],
    "tracks": [
      {
        "entity_id": 42,
        "rma_entity_id": 42,
        "track_number": "string",
        "carrier_title": "string",
        "carrier_code": "string",
        "extension_attributes": {
          "status": "string",
          "delivery_time": "string",
          "external_updated_at": "string",
          "label_filename": "string"
        }
      }
    ],
    "extension_attributes": {
      "rma_return_address": {
        "rma_id": 42,
        "name": "string",
        "street": "string",
        "city": "string",
        "country_id": "string",
        "postcode": "string",
        "telephone": "string",
        "email": "string"
      },
      "merchant_code": "string",
      "date_received": "string",
      "customer_firstname": "string",
      "customer_lastname": "string",
      "date_processed": "string",
      "shipping_address_customer_firstname": "string",
      "shipping_address_customer_lastname": "string"
    },
    "custom_attributes": [
      {
        "attribute_code": "string",
        "value": "string"
      }
    ]
  }
}
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"
}