1. CarrierPortal
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
    • /api/v1/freights
    • /api/v1/freights/share
    • /api/v1/freights/{freightId}
    • /api/v1/freights/{freightId}
    • /api/v1/freights/archive/{freightId}
    • /api/v1/freights/{freightId}
    • /api/v1/freights/archive
  • 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
      POST
    • /api/v1/orders
      POST
    • /api/v1/orders/{orderId}
      PUT
    • /api/v1/orders/{orderId}
      DELETE
    • /api/v1/orders/{orderId}
      GET
    • /api/v1/orders/upsert
      POST
    • /api/v1/orders/query
      POST
    • /api/v1/orders/{orderId}/documents/{documentId}/content
      GET
    • /api/v1/orders/{orderId}/documents/{documentId}/status
      POST
  • 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}
  • 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. CarrierPortal

/api/v1/orders/upsert

POST
https://api-test.spotgo.eu/api/v1/orders/upsert
Used for creating and updating order information.
Uniqueness checked by orderNumber if the carrier information changed VATCode the unique link will be regenerated.
Always returns the link to the documents upload site.

Request

Body Params application/json; x-api-version=1.0

Examples

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/orders/upsert' \
--header 'Content-Type: application/json; x-api-version=1.0' \
--data '{
    "orderNumber": "string",
    "manager": {
        "name": "string",
        "email": "string"
    },
    "carrier": {
        "name": "string",
        "email": "string",
        "vatCode": "string"
    },
    "internalComments": "string",
    "details": {
        "weight": 0,
        "licensePlates": [
            "string"
        ]
    },
    "pricing": {
        "totalAmount": 1250.0,
        "currency": "EUR"
    },
    "locations": [
        {
            "sequence": 0,
            "type": "Loading",
            "startDate": "2019-08-24T14:15:22.123Z",
            "endDate": "2019-08-24T14:15:22.123Z",
            "name": "string",
            "countryCode": "st",
            "postalCode": "string",
            "city": "string",
            "street": "string",
            "position": {
                "latitude": 0,
                "longitude": 0
            },
            "weight": 24000,
            "requiredDocuments": []
        },
        {
            "sequence": 1,
            "type": "Unloading",
            "startDate": "2019-08-25T10:00:00.000Z",
            "endDate": "2019-08-25T10:00:00.000Z",
            "name": "string",
            "countryCode": "st",
            "postalCode": "string",
            "city": "string",
            "street": "string",
            "position": {
                "latitude": 0,
                "longitude": 0
            },
            "weight": 24000,
            "requiredDocuments": [
                {
                    "internalId": "d4e5f6a7-b8c9-0123-def0-234567890123",
                    "type": "pod"
                },
                {
                    "internalId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
                    "type": "cmr"
                }
            ]
        }
    ]
}'
Response Response Example
200 - Example 1
{
    "created": true,
    "updated": true,
    "linkChanged": true,
    "order": {
        "sequenceId": 0,
        "status": "Succeeded",
        "message": "string",
        "errorCode": "string",
        "data": {
            "orderNumber": "string",
            "orderDate": "2019-08-24T14:15:22.123Z",
            "referenceNumber": "string",
            "sentNumber": "string",
            "licensePlates": [
                "string"
            ],
            "trailerTypes": [
                "string"
            ],
            "payer": {
                "name": "string",
                "vatCode": "string",
                "country": "string",
                "postalCode": "string",
                "city": "string",
                "street": "string",
                "contactPerson": {
                    "name": "string",
                    "email": "string",
                    "phone": "string"
                },
                "internalId": "string",
                "drivers": [
                    {
                        "name": "string",
                        "phone": "string"
                    }
                ]
            },
            "customer": {
                "name": "string",
                "vatCode": "string",
                "country": "string",
                "postalCode": "string",
                "city": "string",
                "street": "string",
                "contactPerson": {
                    "name": "string",
                    "email": "string",
                    "phone": "string"
                },
                "internalId": "string",
                "drivers": [
                    {
                        "name": "string",
                        "phone": "string"
                    }
                ]
            },
            "carrier": {
                "name": "string",
                "vatCode": "string",
                "country": "string",
                "postalCode": "string",
                "city": "string",
                "street": "string",
                "contactPerson": {
                    "name": "string",
                    "email": "string",
                    "phone": "string"
                },
                "internalId": "string",
                "drivers": [
                    {
                        "name": "string",
                        "phone": "string"
                    }
                ]
            },
            "customerBranch": {
                "name": "string",
                "vatCode": "string",
                "country": "string",
                "postalCode": "string",
                "city": "string",
                "street": "string",
                "contactPerson": {
                    "name": "string",
                    "email": "string",
                    "phone": "string"
                },
                "internalId": "string",
                "drivers": [
                    {
                        "name": "string",
                        "phone": "string"
                    }
                ]
            },
            "locations": [
                {
                    "sequence": 0,
                    "group": 0,
                    "type": "Loading",
                    "startDate": "2019-08-24T14:15:22.123Z",
                    "endDate": "2019-08-24T14:15:22.123Z",
                    "fixTime": true,
                    "countryCode": "string",
                    "city": "string",
                    "normalizedCity": "string",
                    "postalCode": "string",
                    "street": "string",
                    "normalizedStreet": "string",
                    "name": "string",
                    "normalizedName": "string",
                    "refrenceNumbers": [
                        "string"
                    ],
                    "notes": "string",
                    "coordinates": {
                        "latitude": 0,
                        "longitude": 0
                    },
                    "cargo": [
                        {
                            "cargoType": "string",
                            "weight": 0,
                            "ldm": 0,
                            "pallets": 0,
                            "palletsExchange": true,
                            "adr": true,
                            "stackable": true,
                            "temeratureFrom": 0,
                            "temeratureTo": 0,
                            "refrigeratorUnitMode": "Off",
                            "straps": 0,
                            "matts": 0,
                            "length": 0,
                            "width": 0,
                            "height": 0,
                            "units": "string",
                            "volume": 0,
                            "ftl": true,
                            "vin": "string",
                            "color": "string",
                            "cargoPlate": "string",
                            "productCode": "string"
                        }
                    ],
                    "totalWeight": 0,
                    "totalQuantity": 0,
                    "containerNumber": "string",
                    "containerType": "string",
                    "tasCode": "string",
                    "tarCode": "string",
                    "tarValidity": "string"
                }
            ],
            "payments": {
                "price": 0,
                "basePrice": 0,
                "additionalCharges": 0,
                "paymentDays": 0,
                "currency": "string",
                "isVatInPln": true,
                "totalNetAmount": 0,
                "paymentMethod": "Card",
                "priceBreakdown": [
                    {
                        "type": "string",
                        "quantity": 0,
                        "unitPrice": 0,
                        "amount": 0
                    }
                ]
            },
            "distance": "string",
            "emptyDistance": "string",
            "documentSubmissionMethods": [
                "string"
            ],
            "comments": "string",
            "accountingComments": "string",
            "driverComments": "string",
            "invoiceEmail": "string",
            "links": [
                "string"
            ],
            "penalties": "string",
            "capabilities": [
                "string"
            ],
            "cargoValue": {
                "value": 0,
                "currency": "string"
            },
            "subcontractorPrice": 0,
            "vehiclesLicensePlates": [
                "string"
            ],
            "trailersLicensePlates": [
                "string"
            ],
            "incoterms": "string"
        },
        "metadata": {
            "property1": "string",
            "property2": "string"
        },
        "orderSubType": "Regular"
    }
}
Modified at 2026-06-01 05:23:13
Previous
/api/v1/orders/{orderId}
Next
/api/v1/orders/query
Built with