Mark as Shipped

When you use invoice payment, you need to mark the final delivery. This is essential to calculate the due date of the payment. You should also do this when you use the intent order.

You can set the details using the API. If the Smart Transaction has intent order, you can also use SecuOffice.

The API endpoint for marking a Smart Transaction to be delivered in full is POST /Smart/Transactions/{id}/setDelivery:

Request

POST /api/v2/Smart/Transactions/STX_33PXAW2YN2NJTPM5KPGMK7QF5PBVA2/setDelivery HTTP/1.1
Host: connect-testing.secupay-ag.de
Authorization: Bearer qb56tjj1bcvo9n2nj4u38k84lo
Content-Type: application/json
Accept: application/json
 
{
    "delivery_options": {
        "type": "shipping",
        "shipped_at": "2020-07-06T12:45:00+02:00",
        "shipped_by": "DHL",
        "tracking_code": "123456789",
        "invoice_number": "RG56324"
    }
}

Parameter details in case of shipping:

Parameter	Meaning
`type`	Optional. Always `shipping`.
`shipped_at`	Shipping date and time.
`shipped_by`	Optional name of shipping provider.
`tracking_code`	Optional tracking code or URL of your shipping provider.
`invoice_number`	Optional. Your invoice number.

If everything is fine, the API responds with 200 OK and the full representation of the Smart Transaction:

Response

HTTP/1.1 200 OK
Content-Type: application/json
...
 
{
    "object": "smart.transactions",
    "id": "STX_33PXAW2YN2NJTPM5KPGMK7QF5PBVA2",
    // ...
    "status": "ok",
    // ...
    "delivery_options": {
        "type": "shipping",
        "shipped_at": "2020-07-07T13:01:00+02:00",
        "shipped_by": "DHL",
        "tracking_code": "123456789",
        "invoice_number": "RG56324"
    },
    // ...
}

In case of an order, this would also change the status of the Smart Transaction to shipped. Otherwise it would stay ok.

You can track multiple shipments for one Smart Transaction. This will update the detail fields. If you pass no shipping provider, tracking code or invoice number, it will remove them.