POST /V8/winkelstraat/ios/orderPlace

Body

  • sku string Required
  • shippingMethod string Required
  • paymentMethod string Required
  • customer object Required
    Hide customer attributes Show customer attributes object
    • first_name string Required
    • last_name string Required
    • street string Required
    • house_number string Required
    • postcode string Required
    • city string Required
    • country_code string Required
    • date_of_birth string Required
    • phone_number string Required
    • email_address string Required

Body

  • sku string Required
  • shippingMethod string Required
  • paymentMethod string Required
  • customer object Required
    Hide customer attributes Show customer attributes object
    • first_name string Required
    • last_name string Required
    • street string Required
    • house_number string Required
    • postcode string Required
    • city string Required
    • country_code string Required
    • date_of_birth string Required
    • phone_number string Required
    • email_address string Required

Responses

  • 200 Success.

    Hide response attributes Show response attributes object
    • code string Required
    • message string Required
    • order object Required
      Hide order attribute Show order attribute object
      • increment_id string Required
    • payment_session string Required
    • cancel_token string Required
    Hide response attributes Show response attributes object
    • code string Required
    • message string Required
    • order object Required
      Hide order attribute Show order attribute object
      • increment_id string Required
    • payment_session string Required
    • cancel_token string Required
  • 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 /V8/winkelstraat/ios/orderPlace
curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V8/winkelstraat/ios/orderPlace' \
 --header "Content-Type: application/json" \
 --data '{"sku":"string","shippingMethod":"string","paymentMethod":"string","customer":{"first_name":"string","last_name":"string","street":"string","house_number":"string","postcode":"string","city":"string","country_code":"string","date_of_birth":"string","phone_number":"string","email_address":"string"}}'
curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V8/winkelstraat/ios/orderPlace' \
 --header "Content-Type: application/xml"
Request examples
{
  "sku": "string",
  "shippingMethod": "string",
  "paymentMethod": "string",
  "customer": {
    "first_name": "string",
    "last_name": "string",
    "street": "string",
    "house_number": "string",
    "postcode": "string",
    "city": "string",
    "country_code": "string",
    "date_of_birth": "string",
    "phone_number": "string",
    "email_address": "string"
  }
}
Request examples
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <sku>string</sku>
  <shippingMethod>string</shippingMethod>
  <paymentMethod>string</paymentMethod>
  <customer>
    <first-name>string</first-name>
    <last-name>string</last-name>
    <street>string</street>
    <house-number>string</house-number>
    <postcode>string</postcode>
    <city>string</city>
    <country-code>string</country-code>
    <date-of-birth>string</date-of-birth>
    <phone-number>string</phone-number>
    <email-address>string</email-address>
  </customer>
</root>
Response examples (200)
{
  "code": "string",
  "message": "string",
  "order": {
    "increment_id": "string"
  },
  "payment_session": "string",
  "cancel_token": "string"
}
Response examples (200)
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <code>string</code>
  <message>string</message>
  <order>
    <increment-id>string</increment-id>
  </order>
  <payment-session>string</payment-session>
  <cancel-token>string</cancel-token>
</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>