Referencia de APIResources / Delivery

Update Delivery

PATCH /v1/resource/delivery • validated by `patchDelivery`

← Back to full API reference

PATCH/v1/resource/deliveryAuthentication required

Validated by Zod schema: patchDelivery.

Request details

Path params

No path parameters for this endpoint.

Query params

No explicit query schema was captured for this endpoint.

Body fields

deliveryId (required)
Type: number
deliveredFromDivisionId
Type: number
state
Type: enum
Example: PENDING
address
Type: object
address.postal_code (required)
Type: string
address.country (required)
Type: string
address.details (required)
Type: string
address.neighborhood
Type: string
address.locality
Type: string
address.administrative_area_level_2
Type: string
address.administrative_area_level_1
Type: string
elements
Type: array
Example:
elements[] (required)
Type: object
elements[].resourceId (required)
Type: number
elements[].id (required)
Type: number
elements[].quantity (required)
Type: number
elements[].serialNumbers
Type: array
Example:
elements[].serialNumbers[] (required)
Type: string

Default payloads

Path params

json

{}

Query

json

{}

Body

json

{
  "deliveryId": 1
}

Sample response

json

"<result>"

Test this endpoint now

Use your own credentials and execute a live request directly from this page.

1. Configure authentication for testing

You can test endpoints with signed API keys, a raw Authorization token, or browser cookies. Select one mode and fill in the required fields.

Public keyPrivate key (used only in your browser)X-Bitnation-Organization-Id (opcional)X-Bitnation-User-Email (opcional)

2. Select endpoint

EndpointBase URL

PATCH/v1/resource/deliveryAuthentication required

Group: Resources / Delivery

PATCH /v1/resource/delivery • validated by `patchDelivery`

Validated by Zod schema: patchDelivery.

Body fields

deliveryIdrequired
Type: number
deliveredFromDivisionId
Type: number
state
Type: enum
Ejemplo: PENDING
address
Type: object
address.postal_coderequired
Type: string
address.countryrequired
Type: string
address.detailsrequired
Type: string
address.neighborhood
Type: string
address.locality
Type: string
address.administrative_area_level_2
Type: string
address.administrative_area_level_1
Type: string
elements
Type: array
Ejemplo:
elements[]required
Type: object
elements[].resourceIdrequired
Type: number
elements[].idrequired
Type: number
elements[].quantityrequired
Type: number
elements[].serialNumbers
Type: array
Ejemplo:
elements[].serialNumbers[]required
Type: string

3. Prepare request payload

Query params (JSON)Body (JSON)

4. Server response

Run a request to inspect the real-time response for your environment.

POST /v1/resource/delivery

Previous Page

GET /v1/resource/delivery

Next Page