Read every document retrieved for a resource.

Poll this until is_terminal is true.

A resource_id that exists for this tenant but has produced no documents yet answers 200 with an empty documents array and a non-terminal status -- carriers commonly index images only after delivery, so "nothing yet" is the normal early answer. A resource_id unknown to this tenant, or belonging to another tenant, answers 404 either way: this surface never distinguishes the two.

SecurityAPIKeyHeader
Request
path Parameters
resource_id
required
string (Resource Id)
query Parameters
encoding
string (Encoding) ^(url|base64)$
Default: "url"

'url' (default) returns only the links Genesis already has. 'base64' also inlines file content where one is available and small enough -- it augments the response, it does not replace the link.

header Parameters
X-Shipwell-Version
string (X-Shipwell-Version)

Pins this request to the API as it behaved on the given ISO date, e.g. 2026-08-25. Omitted or unparseable means the oldest behaviour, so a client that never sends it keeps the behaviour it was written against.

Responses
200

Successful Response

Response Schema: application/json
required
object (DocumentCollectionResult)

Every document retrieved for one resource_id, deduplicated across however many retrieval tasks produced them.

Polling is the completion signal, the same as rating and dispatch: is_terminal is false for a resource that exists but has not finished retrieving (including one with no documents at all yet -- carriers commonly index images only after delivery, so an empty documents list here is the ordinary early answer, not an error).

400

Validation Error

404

No such resource_id, or it belongs to another tenant.

500

An unknown internal server issue occured while processing a request. A report is created and logged.

get/documents/{resource_id}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Copyright © Shipwell 2025. All right reserved.