Reject order conditions

This method allows you to reject order received con­di­tions.

Url parameters and connection settings

  • URL: https://api.platform.trans.eu
  • End­point: /ext/orders-api/v1/orders-received/{orderId}/reject
  • Method: PATCH

Headers:

  • Con­tent-type: application/json
  • Accept: application/json
  • Autho­riza­tion: Bear­er {access_token}
  • Api-key: {unique_ap­p_api-key}

Authorization and access

Autho­riza­tion process is described here. Each API request must also con­sist of unique Api-key obtained dur­ing appli­ca­tion reg­is­tra­tion togeth­er with client_id and client_secret.

Example

Sam­ple Json for reject order

{
  "comment": "example comment"
}

Response

{
  "additional_terms": "additional terms",
  "created_at": "2021-06-21T11:38:44.173Z",
  "freight": {
    "carrier": {
      "assignee": null,
      "legal_name": "Firma Testowa Przewoźnik IIT 2",
      "vat_id": "1111111111"
    },
    "id": "",
    "reference_number": null,
    "shipper": {
      "assignee": {
        "account_id": 111111,
        "email": "test@trans.eu",
        "family_name": "Testowy",
        "fax": null,
        "given_name": "Jan",
        "telephone": "0048 1111111111",
        "trans_id": "1111111-1"
      },
      "legal_name": "Firma Testowa Spedycja IIT",
      "vat_id": "11111111111"
    },
    "spots": [
      {
        "description": null,
        "name": null,
        "operations": [
          {
            "loads": [],
            "operation_order": 1,
            "time_window": null,
            "time_window_reason": null,
            "timespans": {
              "begin": "2021-06-22T09:00:00.000Z",
              "end": "2021-06-22T10:00:00.000Z"
            },
            "type": "loading"
          }
        ],
        "place": {
          "address": {
            "country": "pl",
            "description": null,
            "locality": "Kraków",
            "number": null,
            "postal_code": "31-001",
            "street": null
          },
          "coordinates": null
        },
        "spot_order": 1
      },
      {
        "description": null,
        "name": null,
        "operations": [
          {
            "loads": [],
            "operation_order": 1,
            "time_window": null,
            "time_window_reason": null,
            "timespans": {
              "begin": "2021-06-23T09:00:00.000Z",
              "end": "2021-06-23T09:00:00.000Z"
            },
            "type": "unloading"
          }
        ],
        "place": {
          "address": {
            "country": "pl",
            "description": null,
            "locality": "Dąbrowa Środkowa",
            "number": null,
            "postal_code": "59-330",
            "street": null
          },
          "coordinates": null
        },
        "spot_order": 2
      }
    ]
  },
  "id": "1b1ed38b-e4d5-4f7b-a327-0552e2dfd0d0",
  "invoice": null,
  "legacy_freight_id": null,
  "monitoring": {
    "required": true
  },
  "number": "2021/06/21/12",
  "payment": {
    "days": 30,
    "price": {
      "currency": "pln",
      "protected": false,
      "type": "km",
      "value": 1500
    }
  },
  "related": [],
  "source": {
    "author_account_id": 749989,
    "source_date": "2021-06-21T11:38:44.173Z",
    "source_id": "3_api_trans",
    "type": "api"
  },
  "status": {
    "comment": "example comment",
    "value": "proposal-rejected"
  }
}