1. TransactionsFeed
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
      GET
    • /api/v1/freights
      POST
    • /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
    • /api/v1/document-collections/{collectionId}
    • /api/v1/document-collections/{collectionId}/documents/{documentId}/items/{itemId}/file
    • /api/v1/document-collections/{collectionId}/documents/{documentId}/file
  • FreightOffers
    • /api/v1/freights/offers
    • /api/v1/freights/{freightId}/offers/{offerId}
  • Automations
    • Enters driver fines automatically based on parsed file.
    • Gets the status and result of the automation.
  • TransactionsFeed
    • Transaction Feeds
    • /api/v1/transactions-feed
      GET
    • /api/v1/transactions-feed/{transactionId}
      PUT
  • 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
    • AutomationResultsViewModel
    • DriverModel
    • DocumentStatusChangeSubmitModel
    • ApiAutomationStatus
    • TransactionsFeedItemViewModel
    • ExternalErrorItemViewModel
    • TransactionsFeedListViewModel
    • ExternalErrorViewModel
    • TransactionsFeedStatus
    • 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
    • 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. TransactionsFeed

Transaction Feeds

Persistent delivery is the pull-based alternative to standard webhooks.
Instead of SpotGo calling your public endpoint, it writes a notification to the transactions feed for your application to retrieve.

Step 1 — Create a subscription#

Create a subscription with POST /api/v1/webhooks.
FieldValue
eventTypeA specific event type, such as Order or Fine.
callbackAuth.typePersistent
Endpoint: POST /api/v1/webhooks
{
  "eventType": "Order",
  "callbackAuth": {
    "type": "Persistent"
  }
}
A successful request returns 200 OK:
{
  "subscriptionId": "5f7a79b6-5698-460f-9384-f1abea4e8390"
}

After you create a subscription, poll the transactions feed to learn which documents are ready for you.
You have two ways to do this.

Approach A — Retrieve based on document status#

Used to retrieve requested documents based on their status property.
Endpoint parameters are as follows:
ParameterRequiredDescription
eventTypeYesThe subscribed event type, for example Order.
statusNoStatus of the document (e.g. Ready ).
nextTokenNoContinuation token from a previous page of results.

1. Poll for Ready items#

Endpoint: GET /api/v1/transactions-feed?eventType=Order&status=Ready
{
  "items": [
    {
      "transactionId": "8dfc76b7-218b-4d5a-aed6-a73f6c680d20",
      "documentId": "ec85ca8c-e42a-4752-9fd5-e050b8e19115",
      "eventType": "Order",
      "event": "order.process.success",
      "status": "Ready",
      "createdAt": "2026-07-14T10:00:00Z"
    }
  ],
  "nextToken": "nextTokenExample"
}
Each feed item points at a document. Use documentId to fetch the full document details for that eventType.
If the response includes nextToken, call the same endpoint again with that token inside nextToken parameter until every page is read. Keep eventType and status=Ready the same while paging.

2. Acknowledge after processing#

When you have successfully processed an item, acknowledge it:
Endpoint: PUT /api/v1/transactions-feed/{transactionId}
Use the transactionId from the feed item. The request has no body.
A successful acknowledgement returns 204 No Content and moves the item from Ready to Completed.
Acknowledge only after successful processing. Acknowledging an unknown or already completed transaction returns 404 Not Found.

Approach B — Retrieve based on creation time#

Used to retrieve requested documents based on their createdAt property.
Endpoint parameters are as follows:
ParameterRequiredDescription
eventTypeYesThe subscribed event type, for example Order.
dateFromNoUTC timestamp (YYYY-MM-DDTHH:MM:SS). Returns items with createdAt at or after this time. Cannot be in the future.
nextTokenNoContinuation token from a previous page of results.

Poll from a point in time#

Endpoint: GET /api/v1/transactions-feed?eventType=Order&dateFrom=2026-07-14T09:30:00Z
Example:
An Order created at 2026-07-13T09:29:59Z is not returned (before dateFrom).
An Order created at 2026-07-14T10:00:00Z is returned.
Use documentId from each feed item to retrieve the full document from the endpoint based from eventType .
For the next poll, from the array take the last item's createdAt and pass it as dateFrom.
If nextToken is present from the query, to get next page, pass it to nextToken parameter with the same eventType and dateFrom.
Modified at 2026-07-28 06:06:25
Previous
Gets the status and result of the automation.
Next
/api/v1/transactions-feed
Built with