Magento2
GET /V1/winkelstraat/shippingpackingslips

Query parameters

  • shipmentSearchCriteria[filterGroups][0][filters][0][field] string

    Field

  • shipmentSearchCriteria[filterGroups][0][filters][0][value] string

    Value

  • shipmentSearchCriteria[filterGroups][0][filters][0][conditionType] string

    Condition type

  • shipmentSearchCriteria[sortOrders][0][field] string

    Sorting field.

  • shipmentSearchCriteria[sortOrders][0][direction] string

    Sorting direction.

  • shipmentSearchCriteria[pageSize] integer

    Page size.

  • shipmentSearchCriteria[currentPage] integer

    Current page.

  • trackSearchCriteria[filterGroups][0][filters][0][field] string

    Field

  • trackSearchCriteria[filterGroups][0][filters][0][value] string

    Value

  • trackSearchCriteria[filterGroups][0][filters][0][conditionType] string

    Condition type

  • trackSearchCriteria[sortOrders][0][field] string

    Sorting field.

  • trackSearchCriteria[sortOrders][0][direction] string

    Sorting direction.

  • trackSearchCriteria[pageSize] integer

    Page size.

  • trackSearchCriteria[currentPage] integer

    Current page.

Responses

  • 200

    200 Success.

    Hide response attributes Show response attributes object
    • pages array[object] Required
      Hide pages attributes Show pages attributes object
      • shipment_increment_id string
      • track_number string
      • sort_order integer Required
    • base64_content string Required
    • errors array[string] Required
    Hide response attributes Show response attributes object
    • pages array[object] Required
      Hide pages attributes Show pages attributes object
      • shipment_increment_id string
      • track_number string
      • sort_order integer Required
    • base64_content string Required
    • errors array[string] Required
  • 401

    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
  • default

    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
GET /V1/winkelstraat/shippingpackingslips 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/winkelstraat/shippingpackingslips'
Response examples (200) 
{
  "pages": [
    {
      "shipment_increment_id": "string",
      "track_number": "string",
      "sort_order": 42
    }
  ],
  "base64_content": "string",
  "errors": [
    "string"
  ]
}
Response examples (200) 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <pages type="array">
    <page>
      <shipment-increment-id>string</shipment-increment-id>
      <track-number>string</track-number>
      <sort-order type="integer">42</sort-order>
    </page>
  </pages>
  <base64-content>string</base64-content>
  <errors type="array">
    <error>string</error>
  </errors>
</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 (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>