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.

    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

      Hide errors attributes Show errors attributes object
    • code integer

      Error code

    • parameters array[object]

      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

      Hide errors attributes Show errors attributes object
    • code integer

      Error code

    • parameters array[object]

      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

      Hide errors attributes Show errors attributes object
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
POST /V1/products/special-price 
curl \
 -X POST https://magento2.winkelstraat.mac/rest/all/V1/products/special-price \
 -d '{"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"
}