Mark shipments as packed by shipment increment id

POST /V2/shipment/{incrementId}/merchant/packed

Mark shipments as packed by shipment increment id, and an option time stamp. The current time is used, when no (optional) timestamp is provided. Requires a shipment token to authorize the request.

Path parameters

  • incrementId string Required

    Shipment increment id.

Body

  • shipmentToken string Required

    Shipment token. The shipment token is provided through the Shipment Push API.

  • timestamp string

    Leave empty, or provide time in full date and time (ISO 8601) format: 'Y-m-d\TH:i:sP'. Example: 2024-07-27T15:45:00+02:00

Body

  • shipmentToken string Required

    Shipment token. The shipment token is provided through the Shipment Push API.

  • timestamp string

    Leave empty, or provide time in full date and time (ISO 8601) format: 'Y-m-d\TH:i:sP'. Example: 2024-07-27T15:45:00+02:00

Responses

  • 200 Success.

    Returns packed at timestamp in full date and time (ISO 8601) format: 'Y-m-d\TH:i:sP'. Example: 2024-07-27T15:45:00+02:00

    Returns packed at timestamp in full date and time (ISO 8601) format: 'Y-m-d\TH:i:sP'. Example: 2024-07-27T15:45:00+02:00

  • 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

POST /V2/shipment/{incrementId}/merchant/packed
curl \
 --request POST 'https://m2.winkelstraat.nl/rest/all/V2/shipment/{incrementId}/merchant/packed' \
 --header "Content-Type: application/json" \
 --data '{"shipmentToken":"string","timestamp":"string"}'
curl \
 --request POST 'https://m2.winkelstraat.nl/rest/all/V2/shipment/{incrementId}/merchant/packed' \
 --header "Content-Type: application/xml"
Request examples
{
  "shipmentToken": "string",
  "timestamp": "string"
}
Request examples
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <shipmentToken>string</shipmentToken>
  <timestamp>string</timestamp>
</root>
Response examples (200)
string
Response examples (200)
string
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>