Gestiono
Referencia de APIResources / Delivery

Create Delivery

POST /v1/resource/delivery • validated by `postDelivery`

← Back to full API reference
POST/v1/resource/deliveryAuthentication required
  • Validated by Zod schema: postDelivery.

Request details

Path params

No path parameters for this endpoint.

Query params

No explicit query schema was captured for this endpoint.

Body fields

  • invoiceId (required)

    Type: number

  • deliveredFromDivisionId (required)

    Type: number

  • state (required)

    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 (required)

    Type: array

    Example:

  • elements[] (required)

    Type: object

  • elements[].resourceId (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
{
  "invoiceId": 1,
  "deliveredFromDivisionId": 1,
  "state": "PENDING",
  "elements": [
    {
      "resourceId": 1,
      "quantity": 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.

2. Select endpoint

POST/v1/resource/deliveryAuthentication required

Group: Resources / Delivery

POST /v1/resource/delivery • validated by `postDelivery`

  • Validated by Zod schema: postDelivery.

Body fields

  • invoiceIdrequired
    Type: number
  • deliveredFromDivisionIdrequired
    Type: number
  • staterequired
    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
  • elementsrequired
    Type: array
    Ejemplo:
  • elements[]required
    Type: object
  • elements[].resourceIdrequired
    Type: number
  • elements[].quantityrequired
    Type: number
  • elements[].serialNumbers
    Type: array
    Ejemplo:
  • elements[].serialNumbers[]required
    Type: string

3. Prepare request payload

4. Server response

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