Get default customer group

GET /V1/customerGroups/default

Get default customer group.

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/customerGroups/default 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/customerGroups/default'
Response examples (200) 
{
  "id": 42,
  "code": "string",
  "tax_class_id": 42,
  "tax_class_name": "string",
  "extension_attributes": {
    "exclude_website_ids": [
      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 (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"
}

Save page

PUT /V1/cmsPage/{id}

Save page.

Path parameters

  • id string Required

Body

Responses

PUT /V1/cmsPage/{id} 
curl \
 --request PUT 'https://magento2.winkelstraat.mac/rest/all/V1/cmsPage/{id}' \
 --data '{"page":{"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}}'
Request examples 
{
  "page": {
    "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
  }
}
Response examples (200) 
{
  "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
}
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 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"
}

Add/update the specified cart item

PUT /V1/carts/{cartId}/items/{itemId}

Add/update the specified cart item.

Path parameters

Body

Responses

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

Assigns a specified billing address to a specified cart

POST /V1/carts/mine/billing-address

Assigns a specified billing address to a specified cart.

Body

Responses

  • 200

    200 Success.

    Address 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/carts/mine/billing-address 
curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/carts/mine/billing-address' \
 --data '{"address":{"id":42,"region":"string","region_id":42,"region_code":"string","country_id":"string","street":["string"],"company":"string","telephone":"string","fax":"string","postcode":"string","city":"string","firstname":"string","lastname":"string","middlename":"string","prefix":"string","suffix":"string","vat_id":"string","customer_id":42,"email":"string","same_as_billing":42,"customer_address_id":42,"save_in_address_book":42,"extension_attributes":{"discounts":[{"discount_data":{"amount":42.0,"base_amount":42.0,"original_amount":42.0,"base_original_amount":42.0},"rule_label":"string","rule_i_d":42}],"gift_registry_id":42,"pickup_location_code":"string"},"custom_attributes":[{"attribute_code":"string","value":"string"}]},"useForShipping":true}'
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"
      }
    ]
  },
  "useForShipping": true
}
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"
}

quoteGuestCartTotalManagementV1

Bundled API to collect totals for cart based on shipping/payment methods and additional data.

Get rule by ID

GET /V1/salesRules/{ruleId}

Get rule by ID.

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/salesRules/{ruleId} 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/salesRules/{ruleId}'
Response examples (200) 
{
  "rule_id": 42,
  "name": "string",
  "store_labels": [
    {
      "store_id": 42,
      "store_label": "string",
      "extension_attributes": {}
    }
  ],
  "description": "string",
  "website_ids": [
    42
  ],
  "customer_group_ids": [
    42
  ],
  "from_date": "string",
  "to_date": "string",
  "uses_per_customer": 42,
  "is_active": true,
  "condition": {
    "condition_type": "string",
    "conditions": [
      {}
    ],
    "aggregator_type": "string",
    "operator": "string",
    "attribute_name": "string",
    "value": "string",
    "extension_attributes": {}
  },
  "action_condition": {
    "condition_type": "string",
    "conditions": [
      {}
    ],
    "aggregator_type": "string",
    "operator": "string",
    "attribute_name": "string",
    "value": "string",
    "extension_attributes": {}
  },
  "stop_rules_processing": true,
  "is_advanced": true,
  "product_ids": [
    42
  ],
  "sort_order": 42,
  "simple_action": "string",
  "discount_amount": 42.0,
  "discount_qty": 42.0,
  "discount_step": 42,
  "apply_to_shipping": true,
  "times_used": 42,
  "is_rss": true,
  "coupon_type": "string",
  "use_auto_generation": true,
  "uses_per_coupon": 42,
  "simple_free_shipping": "string",
  "extension_attributes": {
    "reward_points_delta": 42,
    "product_groups": [
      "string"
    ]
  }
}
Response examples (401) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (400) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (500) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (default) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

requisitionListRequisitionListRepositoryV1

Interface RequisitionListRepositoryInterface

Set payment information and place order for a specified cart

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

Set payment information and place order for a specified cart.

Body

Responses

  • 200

    200 Success.

    Order ID.
  • 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/guest-carts/{cartId}/payment-information 
curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/guest-carts/{cartId}/payment-information' \
 --data '{"email":"string","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 
{
  "email": "string",
  "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 (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"
}

Set payment information and place order for a specified cart

POST /V1/carts/mine/payment-information

Set payment information and place order 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
  • 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/carts/mine/payment-information 
curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/carts/mine/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 (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"
}

downloadableSampleRepositoryV1

Interface SampleRepositoryInterface

Update downloadable sample of the given product

PUT /V1/products/{sku}/downloadable-links/samples/{id}

Update downloadable sample of the given product

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
  • 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/{sku}/downloadable-links/samples/{id} 
curl \
 --request PUT 'https://magento2.winkelstraat.mac/rest/all/V1/products/{sku}/downloadable-links/samples/{id}' \
 --data '{"sample":{"id":42,"title":"string","sort_order":42,"sample_type":"string","sample_file":"string","sample_file_content":{"file_data":"string","name":"string","extension_attributes":{}},"sample_url":"string","extension_attributes":{}},"isGlobalScopeContent":true}'
Request examples 
{
  "sample": {
    "id": 42,
    "title": "string",
    "sort_order": 42,
    "sample_type": "string",
    "sample_file": "string",
    "sample_file_content": {
      "file_data": "string",
      "name": "string",
      "extension_attributes": {}
    },
    "sample_url": "string",
    "extension_attributes": {}
  },
  "isGlobalScopeContent": true
}
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 (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 all options for configurable product

GET /V1/configurable-products/{sku}/options/all

Get all options for configurable product

Path parameters

Responses

  • 200

    200 Success.

    Hide response attributes Show response 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/configurable-products/{sku}/options/all 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/configurable-products/{sku}/options/all'
Response examples (200) 
[
  {
    "id": 42,
    "attribute_id": "string",
    "label": "string",
    "position": 42,
    "is_use_default": true,
    "values": [
      {
        "value_index": "string",
        "extension_attributes": {}
      }
    ],
    "extension_attributes": {},
    "product_id": 42
  }
]
Response examples (400) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (default) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Save 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 the list of credits for specified companies

GET /V1/companyCredits/

Returns the list of credits for specified companies.

Responses

  • 200

    200 Success.

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

      Credit Data interface.

      Credit Data interface.

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

companyCreditCreditHistoryManagementV1

Update credit history log and retrieve history which match a specified criteria.