# Update Guide

Updates a shipping, transport or devolution.

Endpoint: PUT /{guides-type}/{document-id}.json
Version: 2.0.0
Security: apiKeyAuth

## Path parameters:

  - `guides-type` (string, required)
    The type of the guide document.
    Enum: "shippings", "transports", "devolutions"

  - `document-id` (integer, required)
    The ID of the document.
    Example: 1050

## Query parameters:

  - `api_key` (string, required)
    Your API Key.
    Example: "YOUR_API_KEY"

## Request fields (application/json):

  - `shipping` (object, required)

  - `shipping.date` (string, required)
    dd/mm/yyyy
    Example: "03/12/2017"

  - `shipping.due_date` (string, required)
    dd/mm/yyyy
    Example: "03/12/2017"

  - `shipping.loaded_at` (string, required)
    dd/mm/yyyy HH:mm:ss
    Example: "02/12/2017 19:00:00"

  - `shipping.license_plate` (string)
    Example: "11-AA-22"

  - `shipping.address_from` (object, required)

  - `shipping.address_from.detail` (string, required)
    Example: "Rua 5"

  - `shipping.address_from.city` (string, required)
    Example: "Lisboa"

  - `shipping.address_from.postal_code` (string, required)
    Example: "1000-555"

  - `shipping.address_from.country` (string, required)
    Example: "Portugal"

  - `shipping.address_to` (object, required)

  - `shipping.reference` (string)
    Example: "999"

  - `shipping.observations` (string)
    Example: "Observations"

  - `shipping.retention` (string)
    Example: "0"

  - `shipping.tax_exemption` (string)
    Example: "M01"

  - `shipping.sequence_id` (string)
    Example: "12345"

  - `shipping.manual_sequence_number` (string)
    Example: "1"

  - `shipping.client` (object, required)

  - `shipping.client.name` (string, required)
    Example: "Client Name"

  - `shipping.client.code` (string, required)
    Example: "A1"

  - `shipping.client.email` (string)
    Example: "foo@bar.com"

  - `shipping.client.address` (string)
    Example: "Saldanha"

  - `shipping.client.fiscal_id` (string)
    Example: "508000000"

  - `shipping.client.website` (string)
    Example: "www.website.com"

  - `shipping.client.phone` (string)
    Example: "910000000"

  - `shipping.client.fax` (string)
    Example: "210000000"

  - `shipping.items` (array, required)

  - `shipping.items.description` (string, required)
    Example: "Item Description"

  - `shipping.items.unit_price` (string, required)
    Example: "100"

  - `shipping.items.quantity` (string, required)
    Example: "5"

  - `shipping.items.unit` (string)
    Example: "service"

  - `shipping.items.discount` (string)
    Example: "50"

  - `shipping.items.tax` (object)

  - `shipping.tax_exemption_reason` (string)
    Example: "M00"

  - `shipping.load_site` (string)
    Example: "Lisbon, Portugal"

  - `shipping.delivery_site` (string)
    Example: "Madrid, Spain"

## Response 200 fields (application/json):

  - `shipping` (object)

  - `shipping.id` (integer)
    Example: 541797

  - `shipping.status` (string)
    Example: "final"

  - `shipping.archived` (boolean)

  - `shipping.type` (string)
    Example: "Shipping"

  - `shipping.sequence_number` (string)
    Example: "1/D"

  - `shipping.inverted_sequence_number` (string)
    Example: "D/1"

  - `shipping.atcud` (string)
    Example: "ABCD1234-1"

  - `shipping.date` (string)
    Example: "13/07/2017"

  - `shipping.due_date` (string)
    Example: "foo"

  - `shipping.reference` (string)
    Example: "foo"

  - `shipping.observations` (string)
    Example: "foo"

  - `shipping.retention` (string)
    Example: "foo"

  - `shipping.permalink` (string)
    Example: "https://www.app.invoicexpress.com/documents/541797d75bbee48911934cbd4a4294946a324295f52b08"

  - `shipping.saft_hash` (string)
    Example: "vaDf"

  - `shipping.sum` (number)
    Example: 1

  - `shipping.discount` (number)

  - `shipping.before_taxes` (number)
    Example: 1

  - `shipping.taxes` (number)
    Example: 0.07

  - `shipping.total` (number)
    Example: 1.07

  - `shipping.currency` (string)
    Example: "Euro"

  - `shipping.address_from` (object)

  - `shipping.address_from.country` (string)
    Example: "Portugal"

  - `shipping.address_from.postal_code` (string)
    Example: "1050-083"

  - `shipping.address_from.detail` (string)
    Example: "Avenida Duque D'Avila, 46 - 3ºA"

  - `shipping.address_from.city` (string)
    Example: "Lisboa"

  - `shipping.address_to` (object)

  - `shipping.client` (object)

  - `shipping.client.name` (string)
    Example: "John"

  - `shipping.items` (array)

  - `shipping.items.description` (string)
    Example: "foo"

  - `shipping.items.unit_price` (string)
    Example: "1.0"

  - `shipping.items.unit` (string)
    Example: "foo"

  - `shipping.items.quantity` (string)
    Example: "1.0"

  - `shipping.items.tax` (object)

  - `shipping.items.tax.value` (number)
    Example: 7

  - `shipping.items.subtotal` (number)
    Example: 1

  - `shipping.items.tax_amount` (number)
    Example: 0.07

  - `shipping.items.discount_amount` (number)

  - `shipping.sequence_id` (string)
    Example: "12345"

  - `shipping.tax_exemption` (string)
    Example: "M01"

  - `shipping.at_doc_code_id` (string)
    Example: "999"

  - `shipping.license_plate` (string)
    Example: "11-AA-22"

## Response 401 fields (application/json):

  - `errors` (object)

  - `errors.error` (string)
    Example: "Invalid API key"

## Response 404 fields (application/json):

  - `errors` (object)

  - `errors.error` (string)
    Example: "Document not found"

## Response 422 fields (application/json):

  - `errors` (object)

  - `errors.error` (string)
    Example: "Elemento client não fornecido"