Post v1 guestcarts cart id pickuppoint

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://magento2.doc.winkelstraat.nl/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "Magento2 MCP server": {
    "url": "https://magento2.doc.winkelstraat.nl/mcp"
  }
}

Close
POST /V1/guest-carts/{cartId}/pickup-point

Path parameters

  • cartId string Required

    The cart ID.

Body

  • pickUpPoint object Required
    Hide pickUpPoint attributes Show pickUpPoint attributes object
    • pick_up_point_id string Required
    • carrier_method string Required
    • name string
    • address_lines array[string] Required
    • city string Required
    • state string
    • country string Required
    • postal string Required
    • telephone string
    • fax string

Body

  • pickUpPoint object Required
    Hide pickUpPoint attributes Show pickUpPoint attributes object
    • pick_up_point_id string Required
    • carrier_method string Required
    • name string
    • address_lines array[string] Required
    • city string Required
    • state string
    • country string Required
    • postal string Required
    • telephone string
    • fax string

Responses

  • 200 Success.

  • 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/guest-carts/{cartId}/pickup-point
curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/guest-carts/{cartId}/pickup-point' \
 --header "Content-Type: application/json" \
 --data '{"pickUpPoint":{"pick_up_point_id":"string","carrier_method":"string","name":"string","address_lines":["string"],"city":"string","state":"string","country":"string","postal":"string","telephone":"string","fax":"string"}}'
curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/guest-carts/{cartId}/pickup-point' \
 --header "Content-Type: application/xml"
Request examples
{
  "pickUpPoint": {
    "pick_up_point_id": "string",
    "carrier_method": "string",
    "name": "string",
    "address_lines": [
      "string"
    ],
    "city": "string",
    "state": "string",
    "country": "string",
    "postal": "string",
    "telephone": "string",
    "fax": "string"
  }
}
Request examples
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <pickUpPoint>
    <pick-up-point-id>string</pick-up-point-id>
    <carrier-method>string</carrier-method>
    <name>string</name>
    <address-lines type="array">
      <address-line>string</address-line>
    </address-lines>
    <city>string</city>
    <state>string</state>
    <country>string</country>
    <postal>string</postal>
    <telephone>string</telephone>
    <fax>string</fax>
  </pickUpPoint>
</root>
Response examples (200)
true
Response examples (200)
true
Response examples (500)
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (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>