1. DocumentCollections
SpotGo
  • Getting started
    • Introduction
    • Authentication
    • Opportunities vs Orders
    • Mappings
  • Order
    • Orders Processing
    • Integrating Your Order Document Processing: A Guide to Best Practices
    • /api/v1/orders/file
      POST
    • /api/v2/orders/{orderId}
      GET
    • /api/v1/orders/{orderId}/file
      GET
  • Opportunity
    • Opportunities (Freight Qoutes)
    • /api/v1/opportunities
      POST
    • /api/v1/opportunities/file
      POST
    • /api/v1/opportunities/image
      POST
    • /api/v1/opportunities/{opportunityId}
      GET
    • /api/v1/opportunities/{opportunityId}/custom
      GET
    • /api/v1/opportunities/{opportunityId}/default
      GET
  • Freight
    • Freights
    • /api/v1/freights
      POST
    • /api/v1/freights
      GET
    • /api/v1/freights/share
      POST
    • /api/v1/freights/{freightId}
      GET
    • /api/v1/freights/{freightId}
      PUT
    • /api/v1/freights/archive/{freightId}
      GET
    • /api/v1/freights/{freightId}
      DELETE
    • /api/v1/freights/archive
      GET
  • Vehicles
    • /api/v1/vehicles
    • /api/v1/vehicles
    • /api/v1/vehicles/{vehicleId}
    • /api/v1/vehicles/{vehicleId}
    • /api/v1/vehicles/{vehicleId}
  • Feedback
    • /api/v1/feedback
  • Webhook
    • Webhooks flow
    • /api/v1/webhooks
    • /api/v1/webhooks
    • /api/v1/webhooks/{subscriptionId}/reset
    • /api/v1/webhooks/{subscriptionId}/notify
    • /api/v1/webhooks/{subscriptionId}
  • Documents
    • Documents processing
    • /api/v1/documents
    • /api/v1/documents/{documentId}/file
    • /api/v1/documents/invoice/{documentId}
    • /api/v1/documents/receipt/{documentId}
    • /api/v1/documents/cmr/{documentId}
    • /api/v1/documents/fine/{documentId}
    • /api/v1/documents/insurance/{documentId}
  • AccountManagement
    • /api/v1/accounts
    • /api/v1/accounts/block
  • DriversDocuments
    • /api/v1/drivers-documents
    • /api/v1/drivers-documents/{documentId}
  • CarrierPortal
    • Integration flows
    • Webhooks
    • Document Upload
    • /api/v1/orders
    • /api/v1/orders/{orderId}
    • /api/v1/orders/{orderId}
    • /api/v1/orders/{orderId}
    • /api/v1/orders/upsert
    • /api/v1/orders/query
    • /api/v1/orders/{orderId}/documents/{documentId}/content
    • /api/v1/orders/{orderId}/documents/{documentId}/status
  • Classification
    • /api/v1/classifications/email
  • DocumentCollections
    • /api/v1/document-collections/files
      POST
    • /api/v1/document-collections/{collectionId}
      GET
    • /api/v1/document-collections/{collectionId}/documents/{documentId}/items/{itemId}/file
      GET
    • /api/v1/document-collections/{collectionId}/documents/{documentId}/file
      GET
  • FreightOffers
    • /api/v1/freights/offers
    • /api/v1/freights/{freightId}/offers/{offerId}
  • Schemas
    • Schemas
    • WebhookSubscriptionNotificationsRequest
    • CarrierOrderStatus
    • CarrierSubmitModel
    • CarrierViewModel
    • DocumentRejectionReason
    • AlternativePlacesRangeSubmitModel
    • ApiKeyAuthentication
    • BasicAuthentication
    • CustomOpportunityApiAddressModel
    • CustomOpportunityApiDescriptionModel
    • CustomOpportunityApiGeoCoordinateModel
    • CustomOpportunityApiLocationModel
    • CustomOpportunityApiModel
    • CustomOpportunityApiRequirementsModel
    • CustomOpportunityApiViewModel
    • CustomerCustomerListResponse
    • CustomerCustomerViewModel
    • CustomerCustomersSubmitModel
    • CustomerSubmitModel
    • DocumentFileType
    • DocumentStatus
    • DocumentsConvertSubmitModel
    • DocumentsConvertViewModel
    • ErrorItemViewModel
    • ErrorViewModel
    • FeedbackSubmitItemModel
    • FeedbackSubmitModel
    • FeedbackTransactionType
    • FeedbackType
    • FreightCreateViewModel
    • FreightSubmitModel
    • FreightUpdateSubmitModel
    • InvoiceApiAddress
    • InvoiceApiLine
    • InvoiceApiModel
    • InvoiceApiParty
    • InvoiceApiTotal
    • InvoiceResponseViewModel
    • LoadingSideTypes
    • LoadingType
    • LocationAddressSubmitModel
    • LocationCoordinatesSubmitModel
    • LocationPeriodSubmitModel
    • LocationSubmitModel
    • Oauth2Authentication
    • OpportunityApiAddress
    • OpportunityApiCargo
    • OpportunityApiCoordinates
    • OpportunityApiLocation
    • OpportunityApiModel
    • OpportunityApiPayment
    • OpportunityApiPeriod
    • OpportunityApiRequirements
    • OpportunityApiTemperature
    • OpportunityApiTransitInfo
    • OpportunityApiViewModel
    • OpportunityResultModel
    • OpportunityStatus
    • OpportunitySubmitModel
    • OrderConvertSubmitModel
    • OrderConvertViewModel
    • OrderDataViewModel
    • OrderStatus
    • OrderTypes
    • OrderViewCargo
    • OrderViewLocation
    • OrderViewLocationCoordinates
    • OrderViewModel
    • OrderViewParty
    • OrderViewPayments
    • PaymentSubmitModel
    • ProblemDetails
    • RegimeTypes
    • RequirementsSubmitModel
    • SpotGoDocumentType
    • TemperatureSubmitModel
    • VehicleAddressSubmitModel
    • VehicleLoadingLocationSubmitModel
    • VehicleLocationPeriodSubmitModel
    • VehicleRequirementsSubmitModel
    • VehicleResultViewModel
    • VehicleSubmitModel
    • VehicleUnloadingLocationSubmitModel
    • WebhookAuthType
    • WebhookAuthentication
    • WebhookEventType
    • WebhookItemViewModel
    • WebhookSubscriptionRequest
    • WebhookSubscriptionResponse
    • WebhookViewModel
    • AccountBlockSubmitModel
    • AccountSubmitModel
    • AccountViewModel
    • InsuranceApiModel
    • InsuranceCompanyApi
    • InsuranceResponseViewModel
    • FreightShareSubmitModel
    • FreightShareViewModel
    • FreightViewModel
    • FreightsViewModel
    • DriverDocumentTypeResponse
    • DriversDocumentApiModel
    • DriversDocumentsConvertViewModel
    • DriversDocumentsViewModel
    • DocumentStatusChangeSubmitModel
    • ApiAutomationStatus
    • ExternalErrorItemViewModel
    • ExternalErrorViewModel
    • AutomationResultsViewModel
    • OrderDetailsSubmitModel
    • AutomationStartedViewModel
    • OrderDetailsViewModel
    • BankInfoApi
    • OrderDocumentStatus
    • OrderDocumentViewModel
    • CargoSubmitModel
    • OrderLocationSubmitModel
    • CargoViewModel
    • OrderLocationType
    • CmrAttachmentApiModel
    • OrderLocationViewModel
    • CmrCargoLoadingApiModel
    • OrderQueryItemViewModel
    • CmrCargoUnloadingApiModel
    • OrderQuerySubmitModel
    • CmrCarrierApiModel
    • OrderQueryViewModel
    • CmrDriverApiModel
    • OrderShareViewModel
    • CmrGoodsApiModel
    • OrderSubmitModel
    • CmrIssueApiModel
    • OrderUpsertViewModel
    • CmrPartyApiModel
    • CmrPaymentApiModel
    • PositionSubmitModel
    • CmrReiceivalApiModel
    • CmrResponseApiModel
    • QueryDateRange
    • CmrResponseViewModel
    • CollectionDocumentType
    • ContractCarrierApiModel
    • DocumentCollectionDataViewModel
    • DocumentCollectionDocumentDataViewModel
    • DocumentCollectionDocumentViewModel
    • DocumentCollectionStatus
    • DocumentCollectionUploadViewModel
    • DocumentCollectionViewModel
    • DocumentPagesViewModel
    • DocumentsConvertSubmitModelBase
    • DriverAddressModel
    • DriverFinesSubmitModel
    • DriverGender
    • DriverLicenseDetailsModel
    • DriverModel
    • EmailClassificationCategory
    • EmailClassificationSubmitModel
    • EmailClassificationTypes
    • EmailClassificationViewModel
    • ExchangeRateApi
    • FineApiModel
    • FineResponseViewModel
    • FreightAdditionalDataSubmitModel
    • FreightCreatorViewModel
    • FreightListViewModel
    • FreightLocationViewModel
    • FreightOfferCreatorViewModel
    • FreightOfferViewModel
    • FreightOffersViewModel
    • FreightTargetPriceSubmitModel
    • FreightType
    • InsuranceAmountBreakdownApi
    • IntegrationDocumentFinishedSubmitModel
    • IntegrationDocumentTypes
    • IntegrationDocumentsProcessStatus
    • InvoiceLineType
    • LambdaAuthentication
    • LocationAddressViewModel
    • LocationCoordinatesViewModel
    • LocationGroupTypes
    • LocationPeriodViewModel
    • OfferStatus
    • OrderAccountingConvertViewModel
    • OrderCargoValue
    • OrderDriver
    • OrderPriceBreakdown
    • OrderSubType
    • OrderViewPartyContactPerson
    • PaymentTypes
    • PaymentViewModel
    • ReceiptApiModel
    • ReceiptItemApiModel
    • ReceiptMerchantApiModel
    • ReceiptResponseViewModel
    • RefrigeratorUnitMode
    • RequirementsViewModel
    • SqsAuthentication
    • TemperatureViewModel
  1. DocumentCollections

/api/v1/document-collections/{collectionId}

GET
https://api-test.spotgo.eu/api/v1/document-collections/{collectionId}

Request

Path Params

Responses

🟢200
application/json; x-api-version=1.0
OK
Body

🟠400
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api-test.spotgo.eu/api/v1/document-collections/'
Response Response Example
200 - Example 1
{
    "status": "Failed",
    "errorCode": "string",
    "message": "string",
    "data": {
        "orderNumberReferences": [
            "string"
        ],
        "documents": [
            {
                "documentId": "string",
                "name": "string",
                "link": "string",
                "errorCode": "string",
                "message": "string",
                "data": [
                    {
                        "itemId": "string",
                        "link": "string",
                        "type": "Other",
                        "pages": {
                            "from": 0,
                            "to": 0
                        },
                        "invoice": {
                            "number": "string",
                            "date": "2019-08-24T14:15:22.123Z",
                            "referenceNumbers": [
                                "string"
                            ],
                            "vehicleLicensePlates": [
                                "string"
                            ],
                            "seller": {
                                "clientId": "string",
                                "name": "string",
                                "vatCode": "string",
                                "companyCode": "string",
                                "bankInfo": [
                                    {
                                        "iban": "string",
                                        "bankName": "string",
                                        "swiftCode": "string",
                                        "currency": "string"
                                    }
                                ],
                                "address": {
                                    "street": "string",
                                    "city": "string",
                                    "postalCode": "string",
                                    "countryCode": "string"
                                }
                            },
                            "buyer": {
                                "clientId": "string",
                                "name": "string",
                                "vatCode": "string",
                                "companyCode": "string",
                                "bankInfo": [
                                    {
                                        "iban": "string",
                                        "bankName": "string",
                                        "swiftCode": "string",
                                        "currency": "string"
                                    }
                                ],
                                "address": {
                                    "street": "string",
                                    "city": "string",
                                    "postalCode": "string",
                                    "countryCode": "string"
                                }
                            },
                            "lines": [
                                {
                                    "name": "string",
                                    "quantity": 0,
                                    "unit": "string",
                                    "discount": 0,
                                    "unitPrice": 0,
                                    "netPrice": 0,
                                    "vatRate": 0,
                                    "vatAmount": 0,
                                    "totalPrice": 0,
                                    "orderProductId": "string",
                                    "cmrNumber": "string",
                                    "vehiclePlates": [
                                        "string"
                                    ],
                                    "referenceNumbers": [
                                        "string"
                                    ],
                                    "route": "string",
                                    "loadingDate": "2019-08-24T14:15:22.123Z",
                                    "unloadingDate": "2019-08-24T14:15:22.123Z",
                                    "lineType": "Service",
                                    "lineCode": "string",
                                    "sequenceId": 0
                                }
                            ],
                            "exchangeRates": [
                                {
                                    "currencyFrom": "string",
                                    "currencyTo": "string",
                                    "rate": 0,
                                    "date": "2019-08-24T14:15:22.123Z"
                                }
                            ],
                            "total": [
                                {
                                    "net": 0,
                                    "vat": 0,
                                    "gross": 0,
                                    "currency": "string",
                                    "paymentDueDate": "2019-08-24T14:15:22.123Z",
                                    "paymentDaysTerm": 0
                                }
                            ]
                        },
                        "cmr": {
                            "sender": {
                                "name": "string",
                                "postalCode": "string",
                                "country": "string",
                                "city": "string",
                                "address": "string"
                            },
                            "consignee": {
                                "name": "string",
                                "postalCode": "string",
                                "country": "string",
                                "city": "string",
                                "address": "string"
                            },
                            "unloading": {
                                "postalCode": "string",
                                "country": "string",
                                "city": "string",
                                "address": "string",
                                "date": "2019-08-24T14:15:22.123Z"
                            },
                            "loading": {
                                "postalCode": "string",
                                "country": "string",
                                "city": "string",
                                "address": "string",
                                "date": "2019-08-24T14:15:22.123Z",
                                "isSigned": true,
                                "isStamped": true,
                                "arrivalDate": "2019-08-24T14:15:22.123Z"
                            },
                            "attachments": [
                                {
                                    "type": "string",
                                    "name": "string",
                                    "number": "string"
                                }
                            ],
                            "marksAndNumbers": [
                                "string"
                            ],
                            "goodsItems": [
                                {
                                    "description": "string",
                                    "quantity": 0,
                                    "packing": "string",
                                    "cnCode": "string",
                                    "grossWeight": 0,
                                    "volume": 0
                                }
                            ],
                            "consignorInstructions": [
                                "string"
                            ],
                            "carriers": [
                                {
                                    "name": "string",
                                    "postalCode": "string",
                                    "country": "string",
                                    "city": "string",
                                    "address": "string",
                                    "licensePlates": [
                                        "string"
                                    ]
                                }
                            ],
                            "specialAgreements": "string",
                            "paymentInfo": {
                                "sender": "string",
                                "consignee": "string",
                                "deduction": "string",
                                "charge": "string",
                                "misc": "string",
                                "currency": "string",
                                "amount": 0
                            },
                            "placeDateOfIssue": {
                                "postalCode": "string",
                                "country": "string",
                                "city": "string",
                                "address": "string",
                                "date": "2019-08-24T14:15:22.123Z"
                            },
                            "contractingCarrier": {
                                "name": "string",
                                "postalCode": "string",
                                "country": "string",
                                "city": "string",
                                "address": "string",
                                "licensePlates": [
                                    "string"
                                ],
                                "isSigned": true,
                                "isStamped": true
                            },
                            "drivers": [
                                {
                                    "name": "string",
                                    "surname": "string"
                                }
                            ],
                            "shipmentReceived": {
                                "receivedDate": "2019-08-24T14:15:22.123Z",
                                "receivedTime": "2019-08-24T14:15:22.123Z",
                                "isSigned": true,
                                "isStamped": true
                            },
                            "stamps": [
                                0
                            ]
                        }
                    }
                ]
            }
        ]
    },
    "metadata": {
        "property1": "string",
        "property2": "string"
    }
}
Modified at 2026-07-18 08:36:46
Previous
/api/v1/document-collections/files
Next
/api/v1/document-collections/{collectionId}/documents/{documentId}/items/{itemId}/file
Built with