Update Stock

Update the action for a shipment that is currently locked in stock (e.g. failed delivery attempt). Choose between retrying delivery, delivering to a new address, or returning to sender.

POST /stock/update

Request

Headers

Header	Value
`Authorization`	`Bearer <your_api_token>`
`Content-Type`	`application/json`

Body Parameters

Field	Type	Required	Description
`ldv`	`string`	Yes	Tracking number (LDV) of the shipment in stock
`action`	`string`	Yes	Action to take: `"RETRY"`, `"NEWADDRESS"`, or `"RETURN"`
`scheduled_at`	`string`	Yes	Scheduled date for the action (format: `DD/MM/YYYY`)
`newaddress`	`object`	Conditional	New delivery address — required when `action` is `"NEWADDRESS"`
`note`	`string`	No	Additional notes for the carrier

Actions

Value	Description
`RETRY`	Retry delivery to the original address
`NEWADDRESS`	Deliver to a new address (requires `newaddress` object)
`RETURN`	Return the shipment to sender

New Address Object (required for `NEWADDRESS`)

Field	Type	Required	Description
`name`	`string`	Yes	Full name
`company`	`string`	No	Company name
`street1`	`string`	Yes	Primary address line
`street2`	`string`	No	Secondary address line
`city`	`string`	Yes	City
`state`	`string`	Yes	State/Province code
`postalCode`	`string`	Yes	Postal/ZIP code
`country`	`string`	Yes	2-letter ISO country code (e.g. `IT`)
`phone`	`number`	No	Phone number
`email`	`string`	Yes	Email address
`notes`	`string`	Yes	Delivery notes (e.g. floor, buzzer code)

Examples

NEWADDRESS


{
  "ldv": "281095I072409",
  "action": "NEWADDRESS",
  "scheduled_at": "26/06/2021",
  "newaddress": {
    "name": "Mario Rossi",
    "company": "",
    "street1": "Via Roma 2",
    "street2": "",
    "city": "Telese Terme",
    "state": "BN",
    "postalCode": "82037",
    "country": "IT",
    "phone": 333123456,
    "email": "email@example.com",
    "notes": "al piano 2"
  },
  "note": "please call"
}

RETRY


{
  "ldv": "281095I072409",
  "action": "RETRY",
  "scheduled_at": "26/06/2021"
}

RETURN


{
  "ldv": "281095I072409",
  "action": "RETURN",
  "scheduled_at": "26/06/2021"
}

Response

Returns 200 OK on success with no body.

The ldv (tracking number) can be retrieved from the trackingNumber field in the Create Shipping Label response.

Error Codes

Code	Description
`200`	OK — stock updated