Add Shipping to Invoice

Production

https://{{subdomain}}.daftra.com/api2

POST

/invoices/add_shipping/{id}{format}

Sets shipping details on an existing invoice.

The invoice is identified by the id path parameter. Send the shipping fields nested under the Invoice object — all are optional, and only the fields you include (with a non-empty value) are applied:

Field	Meaning
`shipping_option_id`	ID of a shipping option to apply
`shipping_amount`	Shipping fee added to the invoice total
`shipping_tax_id`	ID of the tax applied to the shipping fee
`shipping_number`	Tracking/shipping number, recorded as the invoice's "Shipping Number" custom field

Empty or 0 values are ignored, so this endpoint can set or overwrite shipping fields but cannot clear them. A request that includes no shipping fields still returns a success response without changing the invoice.

The response is 403 when no invoice matches the given ID.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

The invoice shipping was updated.

Bodyapplication/json

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://.daftra.com/api2/invoices/add_shipping/2415.json' \
--header 'Accept: application/json' \
--header 'apikey: ' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "Invoice": {
        "shipping_option_id": 3,
        "shipping_amount": 25,
        "shipping_tax_id": 7,
        "shipping_number": "TRK-123"
    }
}'

Response Example

200 - Example 1

{
    "result": "successful",
    "code": 200,
    "message": "Invoice shipping has been updated"
}

Assign Work Order to Invoice

Convert Sales Order to Invoice