Get v1 winkelstraat dock nxt merchant code shipment

GET /V1/winkelstraat/dock_nxt/{merchantCode}/shipment/

Path parameters

merchantCode string Required

Query parameters

searchCriteria[filterGroups][0][filters][0][field] string

Field
searchCriteria[filterGroups][0][filters][0][value] string

Value
searchCriteria[filterGroups][0][filters][0][conditionType] string

Condition type
searchCriteria[sortOrders][0][field] string

Sorting field.
searchCriteria[sortOrders][0][direction] string

Sorting direction.
searchCriteria[pageSize] integer

Page size.
searchCriteria[currentPage] integer

Current page.

Responses

200

application/json

application/json application/xml

200 Success.
Hide response attributes Show response attributes object
- items array[object] Required
  
  Array of collection items.
  
  ShipmentInterface provides methods to manage and manipulate data specific to Shipment processes.
  
  Hide items attributes Show items attributes object
  
  customer_name string Required
  
  The customer's name.
  
  customer_telephone string
  
  The customer's telephone number.
  
  items array[object] Required
  
  Items.
  
  Hide items attributes Show items attributes object
  
  sku string Required
  
  SKU
  
  name string Required
  
  Name
  
  reference string
  
  Reference
  
  mpn string
  
  Article number
  
  size string Required
  
  Size
  
  color string Required
  
  Color
  
  quantity integer Required
  
  Quantity
  
  image_url string Required
  
  Image URL
  
  price number Required
  
  Price
  
  credit_memo_item_statuses array[object] Required
  
  Credit memo item statuses
  
  Hide credit_memo_item_statuses attributes Show credit_memo_item_statuses attributes object
  
  quantity integer Required
  
  reason string Required
  
  The reason for the credit memo item status, possible values: ["deficient", "none", "canceled", "funded_by_platform"]
  
  manufacturer string
  
  Manufacturer
  
  category string
  
  Category
  
  shipment_increment_id string Required
  
  The shipment increment ID.
  
  order_increment_id string Required
  
  The order increment ID.
  
  created_at string Required
  
  The shipment date.
  
  discount number Required
  
  The discount applied.
  
  grand_total number Required
  
  The grand total amount.
  
  shipping_method string
  
  The preferred shipping method by the customer.
  
  picking_pdf_url string
  
  The URL of the picking PDF.
  
  carrier_code string
  
  The preferred carrier code by the customer.
  
  carrier_method string
  
  The preferred carrier method by the customer.
  
  logistics_service_provider_code string
  
  The logistics service provider code.
  
  available_delivery_methods array[object] Required
  
  Available delivery methods.
  
  Hide available_delivery_methods attributes Show available_delivery_methods attributes object
  
  carrier_code string Required
  
  Carrier code
  
  carrier_method string Required
  
  Carrier method
  
  package_point object
  
  Hide package_point attributes Show package_point attributes object
  
  identifier string
  
  carrier_code string
  
  street_lines array[string]
  
  postcode string
  
  city string
  
  state string
  
  country_id string
  
  email string
  
  fax string
  
  telephone string
  
  name string Required
  
  addressee object
  
  Hide addressee attributes Show addressee attributes object
  
  housenumber string
  
  name string
  
  country string
  
  postcode string
  
  street string
  
  province string
  
  city string
  
  purchase_origin string
  
  The purchase origin.
  
  po_number string
  
  The PO number.
  
  track object
  
  Hide track attributes Show track attributes object
  
  track_number string
  
  The track number.
  
  carrier_code string
  
  The carrier code.
  
  shipping_method string
  
  The shipping method.
  
  tracking_url string
  
  The tracking URL.
  
  packed_at string
  
  The packed at timestamp.
- search_criteria object Required
  
  Search criteria interface.
  
  Hide search_criteria attributes Show search_criteria attributes object
  
  filter_groups array[object] Required
  
  A list of filter groups.
  
  Groups two or more filters together using a logical OR
  
  Hide filter_groups attribute Show filter_groups attribute object
  
  filters array[object]
  
  A list of filters in this group
  
  Filter which can be used by any methods from service layer.
  
  Hide filters attributes Show filters attributes object
  
  field string Required
  
  Field
  
  value string Required
  
  Value
  
  condition_type string
  
  Condition type
  
  sort_orders array[object]
  
  Sort order.
  
  Data object for sort order.
  
  Hide sort_orders attributes Show sort_orders attributes object
  
  field string Required
  
  Sorting field.
  
  direction string Required
  
  Sorting direction.
  
  page_size integer
  
  Page size.
  
  current_page integer
  
  Current page.
- total_count integer Required
  
  Total count.
Hide response attributes Show response attributes object
- items array[object] Required
  
  Array of collection items.
  
  ShipmentInterface provides methods to manage and manipulate data specific to Shipment processes.
  
  Hide items attributes Show items attributes object
  
  customer_name string Required
  
  The customer's name.
  
  customer_telephone string
  
  The customer's telephone number.
  
  items array[object] Required
  
  Items.
  
  Hide items attributes Show items attributes object
  
  sku string Required
  
  SKU
  
  name string Required
  
  Name
  
  reference string
  
  Reference
  
  mpn string
  
  Article number
  
  size string Required
  
  Size
  
  color string Required
  
  Color
  
  quantity integer Required
  
  Quantity
  
  image_url string Required
  
  Image URL
  
  price number Required
  
  Price
  
  credit_memo_item_statuses array[object] Required
  
  Credit memo item statuses
  
  Hide credit_memo_item_statuses attributes Show credit_memo_item_statuses attributes object
  
  quantity integer Required
  
  reason string Required
  
  The reason for the credit memo item status, possible values: ["deficient", "none", "canceled", "funded_by_platform"]
  
  manufacturer string
  
  Manufacturer
  
  category string
  
  Category
  
  shipment_increment_id string Required
  
  The shipment increment ID.
  
  order_increment_id string Required
  
  The order increment ID.
  
  created_at string Required
  
  The shipment date.
  
  discount number Required
  
  The discount applied.
  
  grand_total number Required
  
  The grand total amount.
  
  shipping_method string
  
  The preferred shipping method by the customer.
  
  picking_pdf_url string
  
  The URL of the picking PDF.
  
  carrier_code string
  
  The preferred carrier code by the customer.
  
  carrier_method string
  
  The preferred carrier method by the customer.
  
  logistics_service_provider_code string
  
  The logistics service provider code.
  
  available_delivery_methods array[object] Required
  
  Available delivery methods.
  
  Hide available_delivery_methods attributes Show available_delivery_methods attributes object
  
  carrier_code string Required
  
  Carrier code
  
  carrier_method string Required
  
  Carrier method
  
  package_point object
  
  Hide package_point attributes Show package_point attributes object
  
  identifier string
  
  carrier_code string
  
  street_lines array[string]
  
  postcode string
  
  city string
  
  state string
  
  country_id string
  
  email string
  
  fax string
  
  telephone string
  
  name string Required
  
  addressee object
  
  Hide addressee attributes Show addressee attributes object
  
  housenumber string
  
  name string
  
  country string
  
  postcode string
  
  street string
  
  province string
  
  city string
  
  purchase_origin string
  
  The purchase origin.
  
  po_number string
  
  The PO number.
  
  track object
  
  Hide track attributes Show track attributes object
  
  track_number string
  
  The track number.
  
  carrier_code string
  
  The carrier code.
  
  shipping_method string
  
  The shipping method.
  
  tracking_url string
  
  The tracking URL.
  
  packed_at string
  
  The packed at timestamp.
- search_criteria object Required
  
  Search criteria interface.
  
  Hide search_criteria attributes Show search_criteria attributes object
  
  filter_groups array[object] Required
  
  A list of filter groups.
  
  Groups two or more filters together using a logical OR
  
  Hide filter_groups attribute Show filter_groups attribute object
  
  filters array[object]
  
  A list of filters in this group
  
  Filter which can be used by any methods from service layer.
  
  Hide filters attributes Show filters attributes object
  
  field string Required
  
  Field
  
  value string Required
  
  Value
  
  condition_type string
  
  Condition type
  
  sort_orders array[object]
  
  Sort order.
  
  Data object for sort order.
  
  Hide sort_orders attributes Show sort_orders attributes object
  
  field string Required
  
  Sorting field.
  
  direction string Required
  
  Sorting direction.
  
  page_size integer
  
  Page size.
  
  current_page integer
  
  Current page.
- total_count integer Required
  
  Total count.
401

application/json

application/json application/xml

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  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
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  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
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  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
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
default

application/json

application/json application/xml

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  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
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  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
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  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
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

GET /V1/winkelstraat/dock_nxt/{merchantCode}/shipment/

curl \
 --request GET 'https://m2.winkelstraat.nl/rest/all/V1/winkelstraat/dock_nxt/{merchantCode}/shipment/'

Response examples (200)

{
  "items": [
    {
      "customer_name": "string",
      "customer_telephone": "string",
      "items": [
        {
          "sku": "string",
          "name": "string",
          "reference": "string",
          "mpn": "string",
          "size": "string",
          "color": "string",
          "quantity": 42,
          "image_url": "string",
          "price": 42.0,
          "credit_memo_item_statuses": [
            {
              "quantity": 42,
              "reason": "string"
            }
          ],
          "manufacturer": "string",
          "category": "string"
        }
      ],
      "shipment_increment_id": "string",
      "order_increment_id": "string",
      "created_at": "string",
      "discount": 42.0,
      "grand_total": 42.0,
      "shipping_method": "string",
      "picking_pdf_url": "string",
      "carrier_code": "string",
      "carrier_method": "string",
      "logistics_service_provider_code": "string",
      "available_delivery_methods": [
        {
          "carrier_code": "string",
          "carrier_method": "string"
        }
      ],
      "package_point": {
        "identifier": "string",
        "carrier_code": "string",
        "street_lines": [
          "string"
        ],
        "postcode": "string",
        "city": "string",
        "state": "string",
        "country_id": "string",
        "email": "string",
        "fax": "string",
        "telephone": "string",
        "name": "string"
      },
      "addressee": {
        "housenumber": "string",
        "name": "string",
        "country": "string",
        "postcode": "string",
        "street": "string",
        "province": "string",
        "city": "string"
      },
      "purchase_origin": "string",
      "po_number": "string",
      "track": {
        "track_number": "string",
        "carrier_code": "string",
        "shipping_method": "string",
        "tracking_url": "string"
      },
      "packed_at": "string"
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "string",
            "value": "string",
            "condition_type": "string"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "string",
        "direction": "string"
      }
    ],
    "page_size": 42,
    "current_page": 42
  },
  "total_count": 42
}

Response examples (200)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <items type="array">
    <item>
      <customer-name>string</customer-name>
      <customer-telephone>string</customer-telephone>
      <items type="array">
        <item>
          <sku>string</sku>
          <name>string</name>
          <reference>string</reference>
          <mpn>string</mpn>
          <size>string</size>
          <color>string</color>
          <quantity type="integer">42</quantity>
          <image-url>string</image-url>
          <price type="float">42.0</price>
          <credit-memo-item-statuses type="array">
            <credit-memo-item-status>
              <quantity type="integer">42</quantity>
              <reason>string</reason>
            </credit-memo-item-status>
          </credit-memo-item-statuses>
          <manufacturer>string</manufacturer>
          <category>string</category>
        </item>
      </items>
      <shipment-increment-id>string</shipment-increment-id>
      <order-increment-id>string</order-increment-id>
      <created-at>string</created-at>
      <discount type="float">42.0</discount>
      <grand-total type="float">42.0</grand-total>
      <shipping-method>string</shipping-method>
      <picking-pdf-url>string</picking-pdf-url>
      <carrier-code>string</carrier-code>
      <carrier-method>string</carrier-method>
      <logistics-service-provider-code>string</logistics-service-provider-code>
      <available-delivery-methods type="array">
        <available-delivery-method>
          <carrier-code>string</carrier-code>
          <carrier-method>string</carrier-method>
        </available-delivery-method>
      </available-delivery-methods>
      <package-point>
        <identifier>string</identifier>
        <carrier-code>string</carrier-code>
        <street-lines type="array">
          <street-line>string</street-line>
        </street-lines>
        <postcode>string</postcode>
        <city>string</city>
        <state>string</state>
        <country-id>string</country-id>
        <email>string</email>
        <fax>string</fax>
        <telephone>string</telephone>
        <name>string</name>
      </package-point>
      <addressee>
        <housenumber>string</housenumber>
        <name>string</name>
        <country>string</country>
        <postcode>string</postcode>
        <street>string</street>
        <province>string</province>
        <city>string</city>
      </addressee>
      <purchase-origin>string</purchase-origin>
      <po-number>string</po-number>
      <track>
        <track-number>string</track-number>
        <carrier-code>string</carrier-code>
        <shipping-method>string</shipping-method>
        <tracking-url>string</tracking-url>
      </track>
      <packed-at>string</packed-at>
    </item>
  </items>
  <search-criteria>
    <filter-groups type="array">
      <filter-group>
        <filters type="array">
          <filter>
            <field>string</field>
            <value>string</value>
            <condition-type>string</condition-type>
          </filter>
        </filters>
      </filter-group>
    </filter-groups>
    <sort-orders type="array">
      <sort-order>
        <field>string</field>
        <direction>string</direction>
      </sort-order>
    </sort-orders>
    <page-size type="integer">42</page-size>
    <current-page type="integer">42</current-page>
  </search-criteria>
  <total-count type="integer">42</total-count>
</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>