/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

Body

🟠400

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 Example

200 - Example 1

{
    "created": true,
    "updated": true,
    "linkChanged": true,
    "order": {
        "orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
        "status": "Created",
        "orderNumber": "string",
        "createdAt": "2019-08-24T14:15:22.123Z",
        "carrier": {
            "name": "string",
            "email": "string",
            "vatCode": "string"
        },
        "requiredDocumentTypes": [
            "string"
        ],
        "internalComments": "string",
        "details": {
            "weight": 0,
            "licensePlates": [
                "string"
            ]
        },
        "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
                }
            }
        ],
        "documents": [
            {
                "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
                "name": "string",
                "documentType": "string",
                "comment": "string",
                "status": "Processing"
            }
        ],
        "share": {
            "shareUrl": "string"
        }
    }
}

Modified at 2026-06-01 05:23:13

/api/v1/orders/{orderId}

/api/v1/orders/query