Dock Nxt

Get v1 winkelstraat dock nxt merchant code shipment increment

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

Path parameters

  • merchantCode string Required
  • incrementId string Required

Responses

  • 200

    200 Success.

    Hide response attributes Show response 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.

    Hide response attributes Show response 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.
  • 401

    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

    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/{incrementId} 
curl \
 --request GET 'https://m2.winkelstraat.nl/rest/all/V1/winkelstraat/dock_nxt/{merchantCode}/shipment/{incrementId}'
Response examples (200) 
{
  "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"
}
Response examples (200) 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <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>
</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>