POST /V1/requisition_lists

Save Requisition List

Body

  • requisitionList object Required

    Interface RequisitionListInterface

    Hide requisitionList attributes Show requisitionList attributes object
    • id integer Required

      Requisition List ID

    • customer_id integer Required

      Customer ID

    • name string Required

      Requisition List Name

    • updated_at string Required

      Requisition List Update Time

    • description string Required

      Requisition List Description

    • items array[object] Required

      Requisition List Items

      Hide items attributes Show items attributes object

      Interface RequisitionListItemInterface

      • id integer Required

        Requisition List ID.

      • sku string Required

        Product SKU.

      • requisition_list_id integer Required

        Requisition List ID.

      • qty number Required

        Product Qty.

      • options array[string] Required

        Requisition list item options.

      • store_id integer Required

        Store ID.

      • added_at string Required

        Added_at value.

      • extension_attributes object

        ExtensionInterface class for @see \Magento\RequisitionList\Api\Data\RequisitionListItemInterface

    • extension_attributes object

      ExtensionInterface class for @see \Magento\RequisitionList\Api\Data\RequisitionListInterface

Body

  • requisitionList object Required

    Interface RequisitionListInterface

    Hide requisitionList attributes Show requisitionList attributes object
    • id integer Required

      Requisition List ID

    • customer_id integer Required

      Customer ID

    • name string Required

      Requisition List Name

    • updated_at string Required

      Requisition List Update Time

    • description string Required

      Requisition List Description

    • items array[object] Required

      Requisition List Items

      Hide items attributes Show items attributes object

      Interface RequisitionListItemInterface

      • id integer Required

        Requisition List ID.

      • sku string Required

        Product SKU.

      • requisition_list_id integer Required

        Requisition List ID.

      • qty number Required

        Product Qty.

      • options array[string] Required

        Requisition list item options.

      • store_id integer Required

        Store ID.

      • added_at string Required

        Added_at value.

      • extension_attributes object

        ExtensionInterface class for @see \Magento\RequisitionList\Api\Data\RequisitionListItemInterface

    • extension_attributes object

      ExtensionInterface class for @see \Magento\RequisitionList\Api\Data\RequisitionListInterface

Responses

  • 200 Success.

    Hide response attributes Show response attributes object
    • id integer Required

      Requisition List ID

    • customer_id integer Required

      Customer ID

    • name string Required

      Requisition List Name

    • updated_at string Required

      Requisition List Update Time

    • description string Required

      Requisition List Description

    • items array[object] Required

      Requisition List Items

      Hide items attributes Show items attributes object

      Interface RequisitionListItemInterface

      • id integer Required

        Requisition List ID.

      • sku string Required

        Product SKU.

      • requisition_list_id integer Required

        Requisition List ID.

      • qty number Required

        Product Qty.

      • options array[string] Required

        Requisition list item options.

      • store_id integer Required

        Store ID.

      • added_at string Required

        Added_at value.

      • extension_attributes object

        ExtensionInterface class for @see \Magento\RequisitionList\Api\Data\RequisitionListItemInterface

    • extension_attributes object

      ExtensionInterface class for @see \Magento\RequisitionList\Api\Data\RequisitionListInterface

    Hide response attributes Show response attributes object
    • id integer Required

      Requisition List ID

    • customer_id integer Required

      Customer ID

    • name string Required

      Requisition List Name

    • updated_at string Required

      Requisition List Update Time

    • description string Required

      Requisition List Description

    • items array[object] Required

      Requisition List Items

      Hide items attributes Show items attributes object

      Interface RequisitionListItemInterface

      • id integer Required

        Requisition List ID.

      • sku string Required

        Product SKU.

      • requisition_list_id integer Required

        Requisition List ID.

      • qty number Required

        Product Qty.

      • options array[string] Required

        Requisition list item options.

      • store_id integer Required

        Store ID.

      • added_at string Required

        Added_at value.

      • extension_attributes object

        ExtensionInterface class for @see \Magento\RequisitionList\Api\Data\RequisitionListItemInterface

    • extension_attributes object

      ExtensionInterface class for @see \Magento\RequisitionList\Api\Data\RequisitionListInterface

  • 401 Unauthorized

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

  • Internal Server error

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

  • Unexpected error

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

POST /V1/requisition_lists
curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/requisition_lists' \
 --header "Content-Type: application/json" \
 --data '{"requisitionList":{"id":42,"customer_id":42,"name":"string","updated_at":"string","description":"string","items":[{"id":42,"sku":"string","requisition_list_id":42,"qty":42.0,"options":["string"],"store_id":42,"added_at":"string","extension_attributes":{}}],"extension_attributes":{}}}'
curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/requisition_lists' \
 --header "Content-Type: application/xml"
Request examples
{
  "requisitionList": {
    "id": 42,
    "customer_id": 42,
    "name": "string",
    "updated_at": "string",
    "description": "string",
    "items": [
      {
        "id": 42,
        "sku": "string",
        "requisition_list_id": 42,
        "qty": 42.0,
        "options": [
          "string"
        ],
        "store_id": 42,
        "added_at": "string",
        "extension_attributes": {}
      }
    ],
    "extension_attributes": {}
  }
}
Request examples
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <requisitionList>
    <id type="integer">42</id>
    <customer-id type="integer">42</customer-id>
    <name>string</name>
    <updated-at>string</updated-at>
    <description>string</description>
    <items type="array">
      <item>
        <id type="integer">42</id>
        <sku>string</sku>
        <requisition-list-id type="integer">42</requisition-list-id>
        <qty type="float">42.0</qty>
        <options type="array">
          <option>string</option>
        </options>
        <store-id type="integer">42</store-id>
        <added-at>string</added-at>
        <extension-attributes>
        </extension-attributes>
      </item>
    </items>
    <extension-attributes>
    </extension-attributes>
  </requisitionList>
</root>
Response examples (200)
{
  "id": 42,
  "customer_id": 42,
  "name": "string",
  "updated_at": "string",
  "description": "string",
  "items": [
    {
      "id": 42,
      "sku": "string",
      "requisition_list_id": 42,
      "qty": 42.0,
      "options": [
        "string"
      ],
      "store_id": 42,
      "added_at": "string",
      "extension_attributes": {}
    }
  ],
  "extension_attributes": {}
}
Response examples (200)
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <id type="integer">42</id>
  <customer-id type="integer">42</customer-id>
  <name>string</name>
  <updated-at>string</updated-at>
  <description>string</description>
  <items type="array">
    <item>
      <id type="integer">42</id>
      <sku>string</sku>
      <requisition-list-id type="integer">42</requisition-list-id>
      <qty type="float">42.0</qty>
      <options type="array">
        <option>string</option>
      </options>
      <store-id type="integer">42</store-id>
      <added-at>string</added-at>
      <extension-attributes>
      </extension-attributes>
    </item>
  </items>
  <extension-attributes>
  </extension-attributes>
</root>
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 (401)
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>
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 (500)
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>
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"
}
Response examples (default)
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>