SpotGo
  1. Schemas
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
    • /api/v1/orders
    • /api/v2/orders/{orderId}
    • /api/v1/orders/{orderId}/file
  • Opportunity
    • Opportunities (Freight Qoutes)
    • /api/v1/opportunities
    • /api/v1/opportunities/file
    • /api/v1/opportunities/image
    • /api/v1/opportunities/{opportunityId}
    • /api/v1/opportunities/{opportunityId}/custom
    • /api/v1/opportunities/{opportunityId}/default
  • Freight
    • Freight publish
    • /api/v1/freights
    • /api/v1/freights/share
    • /api/v1/freights
    • /api/v1/freights/{freightId}
    • /api/v1/freights/{freightId}
    • /api/v1/freights/{freightId}
  • 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/insurance/{documentId}
  • AccountManagement
    • /api/v1/accounts
    • /api/v1/accounts/block
  • DriversDocuments
    • /api/v1/drivers-documents
    • /api/v1/drivers-documents/{documentId}
  • Schemas
    • Schemas
      • ApiKeyAuthentication
      • AccountBlockSubmitModel
      • InsuranceApiModel
      • FreightShareSubmitModel
      • FreightViewModel
      • DriverDocumentTypeResponse
      • BasicAuthentication
      • AccountSubmitModel
      • InsuranceCompanyApi
      • FreightShareViewModel
      • FreightsViewModel
      • DriversDocumentApiModel
      • CustomOpportunityApiAddressModel
      • AccountViewModel
      • InsuranceResponseViewModel
      • DriversDocumentsConvertViewModel
      • CustomOpportunityApiDescriptionModel
      • DriversDocumentsViewModel
      • 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
    • WebhookSubscriptionNotificationsRequest
  1. Schemas

OrderViewModel

{
    "status": "Succeeded",
    "message": "string",
    "errorCode": "string",
    "data": {
        "orderNumber": "string",
        "orderDate": "2019-08-24T14:15:22.123Z",
        "referenceNumber": "string",
        "licensePlates": [
            "string"
        ],
        "trailerTypes": [
            "string"
        ],
        "payer": {
            "name": "string",
            "vatCode": "string",
            "country": "string",
            "postalCode": "string",
            "city": "string",
            "street": "string"
        },
        "customer": {
            "name": "string",
            "vatCode": "string",
            "country": "string",
            "postalCode": "string",
            "city": "string",
            "street": "string"
        },
        "carrier": {
            "name": "string",
            "vatCode": "string",
            "country": "string",
            "postalCode": "string",
            "city": "string",
            "street": "string"
        },
        "customerBranch": {
            "name": "string",
            "vatCode": "string",
            "country": "string",
            "postalCode": "string",
            "city": "string",
            "street": "string"
        },
        "locations": [
            {
                "sequence": 0,
                "group": 0,
                "type": "Loading",
                "startDate": "2019-08-24T14:15:22.123Z",
                "endDate": "2019-08-24T14:15:22.123Z",
                "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,
                        "straps": 0,
                        "matts": 0,
                        "length": 0,
                        "width": 0,
                        "height": 0,
                        "units": "string"
                    }
                ]
            }
        ],
        "payments": {
            "price": 0,
            "basePrice": 0,
            "additionalCharges": 0,
            "paymentDays": 0,
            "currency": "string"
        },
        "distance": "string",
        "comments": "string",
        "invoiceEmail": "string",
        "links": [
            "string"
        ],
        "penalties": "string"
    },
    "metadata": {
        "property1": "string",
        "property2": "string"
    }
}
Built with