### POST /v1/public/orders/{order_guid}/offers

Source: https://developer.superdispatch.com/documentation/quickstart

Send a load offer to a carrier. This can be done using the carrier's GUID or USDOT number. If the carrier is not registered, their email or phone can be provided to create an offer, which will register them if they accept.

```APIDOC
## POST /v1/public/orders/{order_guid}/offers

### Description
Sends a load offer to a specific carrier for a given order. The offer can be sent using the carrier's `guid` or `usdot` number. If the carrier is not yet registered in Super Dispatch, you can provide `carrier_email` or `carrier_phone` to send the offer, and they will be registered upon acceptance.

### Method
POST

### Endpoint
`/v1/public/orders/<order_guid>/offers`

### Parameters
#### Path Parameters
- **order_guid** (string) - Required - The unique identifier for the order.

#### Query Parameters
None

#### Request Body
- **carrier_guid** (string) - Optional - The unique identifier of the carrier.
- **carrier_usdot** (string) - Optional - The USDOT number of the carrier.
- **carrier_email** (string) - Optional - The email address of the carrier (used if carrier is not registered).
- **carrier_phone** (string) - Optional - The phone number of the carrier (used if carrier is not registered).

### Request Example
```json
{
  "carrier_guid": "9ea8edaf-874b-4dee-8be7-29ab169a21ea"
}
```

### Response
#### Success Response (200)
- **guid** (string) - The unique identifier for the created load offer.

#### Response Example
(Response body is not explicitly defined in the provided text, but it implies a successful creation of a load offer.)
```

--------------------------------

### POST /v1/public/orders

Source: https://developer.superdispatch.com/documentation/quickstart

Creates a new order in the system. The response includes a unique 'guid' for the created order, which can be used for subsequent operations.

```APIDOC
## POST /v1/public/orders

### Description
Creates a new order in the system. The response includes a unique 'guid' for the created order, which can be used for subsequent operations.

### Method
POST

### Endpoint
/v1/public/orders

### Parameters
#### Request Body
- **number** (string) - Required - The order number.
- **instructions** (string) - Optional - General instructions for the order.
- **inspection_type** (string) - Optional - The type of inspection required (e.g., 'standard').
- **broker_fee** (string) - Optional - The broker fee for the order.
- **dispatcher_name** (string) - Optional - The name of the dispatcher.
- **transport_type** (string) - Optional - The type of transport (e.g., 'OPEN').
- **sales_representative** (string) - Optional - The name of the sales representative.
- **price** (string) - Optional - The total price of the order.
- **loadboard_instructions** (string) - Optional - Instructions specific to load boards.
- **pickup** (object) - Required - Details about the pickup location and schedule.
  - **date_type** (string) - Optional - The type of pickup date (e.g., 'estimated').
  - **venue** (object) - Required - Information about the pickup venue.
    - **address** (string) - Required - The street address.
    - **city** (string) - Required - The city.
    - **contact_name** (string) - Optional - The contact person's name.
    - **contact_email** (string) - Optional - The contact person's email.
    - **zip** (string) - Required - The postal code.
    - **contact_phone** (string) - Optional - The contact person's phone number.
    - **state** (string) - Required - The state or province.
    - **name** (string) - Optional - The name of the venue.
  - **notes** (string) - Optional - Additional notes for the pickup.
  - **scheduled_ends_at** (string) - Optional - The scheduled end time for pickup (ISO 8601 format).
  - **scheduled_at** (string) - Optional - The scheduled start time for pickup (ISO 8601 format).
  - **adjusted_date** (string) - Optional - The adjusted pickup date (ISO 8601 format).
- **delivery** (object) - Required - Details about the delivery location and schedule.
  - **date_type** (string) - Optional - The type of delivery date (e.g., 'estimated').
  - **venue** (object) - Required - Information about the delivery venue.
    - **address** (string) - Required - The street address.
    - **city** (string) - Required - The city.
    - **contact_name** (string) - Optional - The contact person's name.
    - **contact_email** (string) - Optional - The contact person's email.
    - **zip** (string) - Required - The postal code.
    - **contact_phone** (string) - Optional - The contact person's phone number.
    - **state** (string) - Required - The state or province.
    - **name** (string) - Optional - The name of the venue.
  - **notes** (string) - Optional - Additional notes for the delivery.
  - **scheduled_ends_at** (string) - Optional - The scheduled end time for delivery (ISO 8601 format).
  - **scheduled_at** (string) - Optional - The scheduled start time for delivery (ISO 8601 format).
  - **adjusted_date** (string) - Optional - The adjusted delivery date (ISO 8601 format).
  - **latitude** (number) - Optional - The latitude of the delivery location.
- **customer** (object) - Required - Details about the customer.
  - **address** (string) - Required - The customer's street address.
  - **city** (string) - Required - The customer's city.
  - **contact_name** (string) - Optional - The customer's contact name.
  - **phone** (string) - Optional - The customer's phone number.
  - **zip** (string) - Required - The customer's postal code.
  - **email** (string) - Optional - The customer's email address.
  - **state** (string) - Required - The customer's state or province.
  - **name** (string) - Optional - The customer's name.
- **payment** (object) - Optional - Payment details for the order.
  - **terms** (string) - Optional - Payment terms (e.g., '5_days').
  - **amount** (string) - Optional - The payment amount.
  - **method** (string) - Optional - The payment method (e.g., 'cash').
  - **notes** (string) - Optional - Payment notes.
  - **reference_number** (string) - Optional - Payment reference number.
- **vehicles** (array) - Required - A list of vehicles associated with the order.
  - **vin** (string) - Required - The Vehicle Identification Number.
  - **lot_number** (string) - Optional - The lot number for the vehicle.
  - **type** (string) - Optional - The type of vehicle (e.g., 'sedan').
  - **color** (string) - Optional - The color of the vehicle.
  - **is_inoperable** (boolean) - Optional - Indicates if the vehicle is inoperable.
  - **curb_weight** (number) - Optional - The curb weight of the vehicle.
  - **price** (number) - Optional - The price associated with the vehicle.
  - **year** (number) - Optional - The manufacturing year of the vehicle.
  - **make** (string) - Optional - The make of the vehicle.
  - **tariff** (string) - Optional - The tariff for the vehicle.
  - **model** (string) - Optional - The model of the vehicle.
  - **curb_weight_unit** (string) - Optional - The unit for curb weight (e.g., 'lbs').
  - **inspection_type** (string) - Optional - The inspection type for the vehicle.

### Request Example
```json
{
  "number": "ORDER-4532",
  "instructions": "",
  "inspection_type": "standard",
  "broker_fee": "50.00",
  "dispatcher_name": "Sherry Turner",
  "transport_type": "OPEN",
  "sales_representative": "Alma Dubois",
  "price": "650.00",
  "loadboard_instructions": "",
  "pickup": {
    "date_type": "estimated",
    "venue": {
      "address": "8 Philmont Dr.",
      "city": "Memphis",
      "contact_name": "Mary Johnson",
      "contact_email": "user@example.com",
      "zip": "38106",
      "contact_phone": "202-555-0147",
      "state": "TN",
      "name": "First Rate Choice"
    },
    "notes": "",
    "scheduled_ends_at": "2019-11-22T10:33:29.112+0000",
    "scheduled_at": "2019-11-20T10:33:29.112+0000",
    "adjusted_date": "2019-11-22T10:33:29.112+0000"
  },
  "delivery": {
    "date_type": "estimated",
    "venue": {
      "address": "8 Philmont Dr.",
      "city": "Memphis",
      "contact_name": "Mary Johnson",
      "contact_email": "user@example.com",
      "zip": "38106",
      "contact_phone": "202-555-0147",
      "state": "TN",
      "name": "First Rate Choice"
    },
    "notes": "",
    "scheduled_ends_at": "2019-11-22T10:33:29.112+0000",
    "scheduled_at": "2019-11-20T10:33:29.112+0000",
    "adjusted_date": null,
    "latitude": 0
  },
  "customer": {
    "address": "8 Philmont Dr.",
    "city": "Memphis",
    "contact_name": "Karen Rodriguez",
    "phone": "202-555-0173",
    "zip": 38106,
    "email": "user@example.com",
    "state": "TN",
    "name": "First Rate Choice"
  },
  "payment": {
    "terms": "5_days",
    "amount": "550.00",
    "method": "cash",
    "notes": null,
    "reference_number": ""
  },
  "vehicles": [
    {
      "vin": "1G8AL52F03Z157046",
      "lot_number": "",
      "type": "sedan",
      "color": "",
      "is_inoperable": false,
      "curb_weight": 2729,
      "price": 60,
      "year": 2012,
      "make": "BMW",
      "tariff": "3.00",
      "model": "X6",
      "curb_weight_unit": "lbs",
      "inspection_type": "standard"
    }
  ]
}
```

### Response
#### Success Response (200)
- **guid** (string) - The unique identifier for the created order.

#### Response Example
```json
{
  "guid": "some-unique-order-guid"
}
```
```

--------------------------------

### Create an Order using cURL

Source: https://developer.superdispatch.com/documentation/quickstart

This snippet demonstrates how to create a new order by sending a POST request to the /v1/public/orders endpoint. It includes the necessary authorization headers and a JSON payload with order details. The response contains a unique 'guid' for the created order.

```curl
curl -X "POST" "https://api.shipper.superdispatch.com/v1/public/orders" \
     -H 'Authorization: Bearer <access_token>' \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "number": "ORDER-4532",
  "instructions": "",
  "inspection_type": "standard"
  "broker_fee": "50.00",
  "dispatcher_name": "Sherry Turner",
  "transport_type": "OPEN",
  "sales_representative": "Alma Dubois",
  "price": "650.00",
  "loadboard_instructions": "",
  "pickup": {
    "date_type": "estimated",
    "venue": {
      "address": "8 Philmont Dr.",
      "city": "Memphis",
      "contact_name": "Mary Johnson",
      "contact_email": "user@example.com",
      "zip": "38106",
      "contact_phone": "202-555-0147",
      "state": "TN",
      "name": "First Rate Choice"
    },
    "notes": "",
    "scheduled_ends_at": "2019-11-22T10:33:29.112+0000",
    "scheduled_at": "2019-11-20T10:33:29.112+0000",
    "adjusted_date": "2019-11-22T10:33:29.112+0000"
  },
  "delivery": {
    "date_type": "estimated",
    "venue": {
      "address": "8 Philmont Dr.",
      "city": "Memphis",
      "contact_name": "Mary Johnson",
      "contact_email": "user@example.com",
      "zip": "38106",
      "contact_phone": "202-555-0147",
      "state": "TN",
      "name": "First Rate Choice"
    },
    "notes": "",
    "scheduled_ends_at": "2019-11-22T10:33:29.112+0000",
    "scheduled_at": "2019-11-20T10:33:29.112+0000",
    "adjusted_date": null,
    "latitude": 0
  },
  "customer": {
    "address": "8 Philmont Dr.",
    "city": "Memphis",
    "contact_name": "Karen Rodriguez",
    "phone": "202-555-0173",
    "zip": 38106,
    "email": "user@example.com",
    "state": "TN",
    "name": "First Rate Choice"
  },
  "payment": {
    "terms": "5_days",
    "amount": "550.00",
    "method": "cash",
    "notes": null,
    "reference_number": ""
  },
  "vehicles": [
    {
      "vin": "1G8AL52F03Z157046",
      "lot_number": "",
      "type": "sedan",
      "color": "",
      "is_inoperable": false,
      "curb_weight": 2729,
      "price": 60,
      "year": 2012,
      "make": "BMW",
      "tariff": "3.00",
      "model": "X6",
      "curb_weight_unit": "lbs",
      "inspection_type": "standard"
    }
  ]
}'
```

--------------------------------

### Authenticate API Client

Source: https://developer.superdispatch.com/documentation/quickstart

This endpoint is used to authenticate your API client by sending your ClientID and ClientSecret. It returns an access token for subsequent API requests.

```APIDOC
## POST /oauth/token

### Description
Authenticates the API client using ClientID and ClientSecret to obtain an access token.

### Method
POST

### Endpoint
/oauth/token

### Query Parameters
- **grant_type** (string) - Required - Must be 'client_credentials'

### Parameters
#### Path Parameters
None

#### Query Parameters
- **grant_type** (string) - Required - Must be 'client_credentials'

#### Request Body
None

### Request Example
```bash
curl -X "POST" "https://api.shipper.superdispatch.com/oauth/token?grant_type=client_credentials" \
     -u 'ClientID:ClientSecret'
```

### Response
#### Success Response (200)
- **access_token** (string) - The authentication token.
- **token_type** (string) - The type of token, usually 'bearer'.
- **expires_in** (integer) - The token's expiration time in seconds.
- **scope** (string) - The granted scopes for the token.
- **aud** (array) - The intended audience for the token.
- **sub** (string) - The subject of the token (e.g., user or client ID).
- **org_guid** (string) - The organization's unique identifier.
- **purpose** (string) - The purpose of the token.
- **iss** (string) - The issuer of the token.
- **iat** (integer) - The issued at timestamp.
- **jti** (string) - The JWT ID.

#### Response Example
```json
{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...o2KLfb1YmrHYu2pycLgXrGN3gqWeFN1ggUhGq1HQBt8",
  "token_type": "bearer",
  "expires_in": 863999,
  "scope": "read write",
  "aud": ["BTMS", "SLB"],
  "sub": "4e31edcf-768c-4766-8d18-b023a1dcc086",
  "org_guid": "dfbe298a-a7bd-4bb2-bc48-d4a512c2a592",
  "purpose": "public_broker_api",
  "iss": "BTMS",
  "iat": 1614678384,
  "jti": "fdd71132-0d28-472d-bb36-d6af47ee7ed4"
}
```
```

--------------------------------

### Send Load Offer to Carrier via API

Source: https://developer.superdispatch.com/documentation/quickstart

This snippet demonstrates how to send a load offer to a carrier using their GUID. The API call creates a load offer and notifies the carrier via email and text message. If the carrier is not registered, their details can be provided to create an offer.

```curl
curl -X "POST" "https://api.shipper.superdispatch.com/v1/public/orders/<order_guid>/offers" \
     -H 'Authorization: Bearer <access_token>' \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "carrier_guid": "9ea8edaf-874b-4dee-8be7-29ab169a21ea"
}'
```

--------------------------------

### GET /v1/public/orders/{guid}/offers

Source: https://developer.superdispatch.com/documentation/order-management

Fetch the list of all offers sent for a particular order. An order can have multiple offers, including active, canceled, or declined ones.

```APIDOC
## GET /v1/public/orders/{guid}/offers

### Description
Retrieve a list of all load offers associated with a specific order.

### Method
GET

### Endpoint
`https://api.shipper.superdispatch.com/v1/public/orders/<guid>/offers`

### Parameters
#### Path Parameters
- **guid** (string) - Required - The unique identifier for the order.

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{} 
```

### Response
#### Success Response (200)
- **offers** (array) - A list of offer objects.
  - Each offer object contains details like `guid`, `carrier_usdot`, `status`, etc.

#### Response Example
```json
{
  "offers": [
    {
      "guid": "offer-guid-123",
      "carrier_usdot": 12345,
      "status": "accepted"
    },
    {
      "guid": "offer-guid-456",
      "carrier_usdot": 67890,
      "status": "canceled"
    }
  ]
}
```
```

--------------------------------

### GET /v1/public/orders/{order_guid}/bol

Source: https://developer.superdispatch.com/documentation/quickstart

Retrieve the Bill of Lading (BOL) for a specific order. The response contains a URL to access the BOL document, typically in PDF format.

```APIDOC
## GET /v1/public/orders/{order_guid}/bol

### Description
Retrieves the Bill of Lading (BOL) for a specified order. The response includes a URL to access the BOL document.

### Method
GET

### Endpoint
`/v1/public/orders/<order_guid>/bol`

### Parameters
#### Path Parameters
- **order_guid** (string) - Required - The unique identifier for the order.

#### Query Parameters
None

#### Request Body
None

### Request Example
```
curl "https://api.shipper.superdispatch.com/v1/public/orders/<order_guid>/bol" \
     -H 'Authorization: Bearer <access_token>'
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the request (e.g., "success").
- **data.object.url** (string) - The URL to access the BOL document.

#### Response Example
```json
{
  "status": "success",
  "data": {
    "object": {
      "url": "https://carrier.superdispatch.com/orders/pdf-bol/wZQ4rMx?template=default"
    }
  }
}
```
```

--------------------------------

### Authenticate API Client using OAuth 2.0 (curl)

Source: https://developer.superdispatch.com/documentation/quickstart

This snippet demonstrates how to authenticate your API client using OAuth 2.0 by sending a POST request to the token endpoint. It requires your ClientID and ClientSecret for basic access authentication. A successful response includes an access token for subsequent API calls.

```curl
curl -X "POST" "https://api.shipper.superdispatch.com/oauth/token?grant_type=client_credentials" \
     -u 'ClientID:ClientSecret'
```

```json
{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...o2KLfb1YmrHYu2pycLgXrGN3gqWeFN1ggUhGq1HQBt8",
  "token_type": "bearer",
  "expires_in": 863999,
  "scope": "read write",
  "aud": ["BTMS", "SLB"],
  "sub": "4e31edcf-768c-4766-8d18-b023a1dcc086",
  "org_guid": "dfbe298a-a7bd-4bb2-bc48-d4a512c2a592",
  "purpose": "public_broker_api",
  "iss": "BTMS",
  "iat": 1614678384,
  "jti": "fdd71132-0d28-472d-bb36-d6af47ee7ed4"
}
```

--------------------------------

### PUT /v1/public/orders/{order_guid}/mark_as_paid

Source: https://developer.superdispatch.com/documentation/quickstart

Marks an order as paid to the carrier. This endpoint allows documenting payment details such as terms, amount, method, date, and reference number.

```APIDOC
## PUT /v1/public/orders/{order_guid}/mark_as_paid

### Description
Marks a specific order as paid to the carrier. This action documents the payment details associated with the order.

### Method
PUT

### Endpoint
`/v1/public/orders/<order_guid>/mark_as_paid`

### Parameters
#### Path Parameters
- **order_guid** (string) - Required - The unique identifier for the order.

#### Query Parameters
None

#### Request Body
- **terms** (string) - Required - Payment terms (e.g., "5_days").
- **amount** (string) - Required - The amount paid.
- **method** (string) - Required - The payment method (e.g., "cash").
- **notes** (string) - Optional - Additional notes regarding the payment.
- **sent_date** (string) - Required - The date and time the payment was sent (ISO 8601 format).
- **reference_number** (string) - Optional - A reference number for the payment.

### Request Example
```json
{
  "terms": "5_days",
  "amount": "550.00",
  "method": "cash",
  "notes": "...",
  "sent_date": "2019-11-18T05:27:36.095+0000",
  "reference_number": "443344"
}
```

### Response
#### Success Response (200)
- The response is a full order object, indicating the order has been marked as paid.

#### Response Example
(The response body is a full order object, not detailed in the provided text.)
```

--------------------------------

### PATCH /v1/public/orders/{order_guid}

Source: https://developer.superdispatch.com/documentation/quickstart

Partially updates an existing order using JSON Merge Patch. Only the fields provided in the request body will be updated.

```APIDOC
## PATCH /v1/public/orders/{order_guid}

### Description
Partially updates an existing order using JSON Merge Patch. Only the fields provided in the request body will be updated. Note that arrays cannot be partially patched and will be completely overwritten if included.

### Method
PATCH

### Endpoint
/v1/public/orders/{order_guid}

### Parameters
#### Path Parameters
- **order_guid** (string) - Required - The unique identifier of the order to update.

#### Request Body
- **price** (number) - Optional - The updated price for the order.
- **pickup** (object) - Optional - An object containing fields to update for the pickup.
  - **scheduled_at** (string) - Optional - The updated scheduled pickup time (ISO 8601 format).
- **delivery** (object) - Optional - An object containing fields to update for the delivery.
  - **scheduled_at** (string) - Optional - The updated scheduled delivery time (ISO 8601 format).

### Request Example
```json
{
    "price": 123.99,
    "pickup": {
        "scheduled_at": "2020-12-22T10:33:29.112+0000"
    },
    "delivery": {
        "scheduled_at": "2020-12-28T10:33:29.112+0000"
    }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the order was updated.

#### Response Example
```json
{
  "message": "Order updated successfully."
}
```
```

--------------------------------

### Mark Order as Paid to Carrier via API

Source: https://developer.superdispatch.com/documentation/quickstart

This snippet illustrates how to mark an order as paid to a carrier. The API request includes payment details such as terms, amount, method, date, and reference number. The response is the full order object.

```curl
curl -X "PUT" "https://api.shipper.superdispatch.com/v1/public/orders/<order_guid>/mark_as_paid" \
     -H 'Authorization: Bearer <access_token>' \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "terms": "5_days",
  "amount": "550.00",
  "method": "cash",
  "notes": "...",
  "sent_date": "2019-11-18T05:27:36.095+0000",
  "reference_number": "443344"
}'
```

--------------------------------

### Example JSON Response - List of Load Offers

Source: https://developer.superdispatch.com/documentation/response-handling

A concrete example of an API response containing a list of load offer objects, along with pagination metadata. This showcases the structure for retrieving multiple resources.

```json
{
  "status": "success",
  "data": {
    "objects": [
      {
        "created_at": "2018-05-30T10:35:01.051+0000",
        "changed_at": "2018-05-30T10:42:20.805+0000",
        "status": "canceled",
        "carrier_email": "acme@example.com",
        "carrier_phone": "202-555-0104",
        "carrier_name": "Acme Corporation",
        "carrier_contact_name": "Arnold Weber",
        "driver_name": "Bernard",
        "driver_phone": "202-555-0181",
        "carrier_guid": "7d57730b-384e-4f46-827e-afa3abbda248",
        "guid": "78e0c452-3cac-4690-808b-0e705a324797",
        "active": true
      },
      {
        "created_at": "2018-05-31T11:39:01.051+0000",
        "changed_at": "2018-05-31T15:42:20.805+0000",
        "status": "accepted",
        "carrier_email": "hooli@example.com",
        "carrier_phone": "202-555-0105",
        "carrier_name": "Hooli",
        "carrier_contact_name": "Gavin Belson",
        "driver_name": "Nelson Bighetti",
        "driver_phone": "202-555-0108",
        "carrier_guid": "3d7c4ce2-7135-4482-a3dd-759833ca7b82",
        "guid": "ae332f7f-ef4e-4e91-92ac-d8efbd33e37d",
        "active": true
      }
    ],
    "pagination": {
      "total_pages": 1,
      "total_objects": 2,
      "limit": 20,
      "page": 0
    }
  }
}
```

--------------------------------

### Example JSON Response - Single Load Offer Object

Source: https://developer.superdispatch.com/documentation/response-handling

An example of a successful API response containing a single load offer object. It includes details like creation and change timestamps, status, and carrier/driver information.

```json
{
  "status": "success",
  "data": {
    "object": {
      "created_at": "2018-05-30T10:35:01.051+0000",
      "changed_at": "2018-05-30T10:42:20.805+0000",
      "status": "canceled",
      "carrier_email": "mail@example.com",
      "carrier_phone": "202-555-0104",
      "carrier_name": "Acme Corporation",
      "carrier_contact_name": "Arnold Weber",
      "driver_name": "Bernard",
      "driver_phone": "202-555-0181",
      "carrier_guid": "532933b06a5a472ba22657bd9ea2375e",
      "guid": "6c827135-9667-41cb-8a76-d58c9c8f6947",
      "active": true
    }
  }
}
```

--------------------------------

### Example JSON Response - Not Found Error

Source: https://developer.superdispatch.com/documentation/response-handling

An example of a 404 Not Found error response from the API when a requested resource, such as a load offer, cannot be found. It includes a descriptive message and an error identifier.

```json
{
  "status": "fail",
  "data": {
    "message": "Offer not found",
    "error_id": "OFFER_NOT_FOUND",
    "details": null
  }
}
```

--------------------------------

### Get Order Bill of Lading (BOL) via API

Source: https://developer.superdispatch.com/documentation/quickstart

This code snippet shows how to retrieve the Bill of Lading (BOL) for a specific order using its GUID. The API returns a JSON object containing a URL to the BOL PDF file.

```curl
curl "https://api.shipper.superdispatch.com/v1/public/orders/<order_guid>/bol" \
     -H 'Authorization: Bearer <access_token>'
```

--------------------------------

### GET /v1/public/orders/price_negotiations/{guid}

Source: https://developer.superdispatch.com/documentation/price-negotiation

Retrieves a specific price negotiation by its unique identifier (GUID).

```APIDOC
## GET /v1/public/orders/price_negotiations/{guid}

### Description
Retrieves the details of a specific price negotiation using its unique GUID.

### Method
GET

### Endpoint
/v1/public/orders/price_negotiations/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - The unique identifier of the price negotiation to retrieve.

### Response
#### Success Response (200)
- **guid** (string) - The unique identifier for the price negotiation.
- **order_guid** (string) - The unique identifier for the associated order.
- **negotiation_budget** (number) - The set negotiation budget.
- **increase_by_percent** (number) - The percentage for bid increase.
- **increase_every** (object) - The interval for bid increase.
  - **value** (number) - The numeric value for the interval.
  - **unit** (string) - The unit of the interval.
- **start_date** (string) - The start date of the negotiation.
- **acceptable_pickup_days** (integer) - Accepted extra pickup days.
- **acceptable_delivery_days** (integer) - Accepted extra delivery days.
- **is_enabled** (boolean) - Indicates if the negotiation is enabled.

#### Response Example
```json
{
  "guid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "order_guid": "86c18bc8-7d1f-4b33-aa22-872572744411",
  "negotiation_budget": 100,
  "increase_by_percent": 10,
  "increase_every": {
      "value": 1,
      "unit": "DAYS"
  },
  "start_date" : "2022-11-09T10:34:07.748+0000",
  "acceptable_pickup_days": 2,
  "acceptable_delivery_days": 1,
  "is_enabled": true
}
```
```

--------------------------------

### GET /v1/public/orders/{order_guid}/price_negotiations

Source: https://developer.superdispatch.com/documentation/price-negotiation

Retrieves all price negotiations associated with a specific order GUID.

```APIDOC
## GET /v1/public/orders/{order_guid}/price_negotiations

### Description
Retrieves a list of all price negotiations associated with a given order GUID.

### Method
GET

### Endpoint
/v1/public/orders/{order_guid}/price_negotiations

### Parameters
#### Path Parameters
- **order_guid** (string) - Required - The unique identifier of the order for which to retrieve price negotiations.

### Response
#### Success Response (200)
- An array of price negotiation objects, each containing:
  - **guid** (string) - The unique identifier for the price negotiation.
  - **order_guid** (string) - The unique identifier for the associated order.
  - **negotiation_budget** (number) - The set negotiation budget.
  - **increase_by_percent** (number) - The percentage for bid increase.
  - **increase_every** (object) - The interval for bid increase.
    - **value** (number) - The numeric value for the interval.
    - **unit** (string) - The unit of the interval.
  - **start_date** (string) - The start date of the negotiation.
  - **acceptable_pickup_days** (integer) - Accepted extra pickup days.
  - **acceptable_delivery_days** (integer) - Accepted extra delivery days.
  - **is_enabled** (boolean) - Indicates if the negotiation is enabled.

#### Response Example
```json
[
  {
    "guid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "order_guid": "86c18bc8-7d1f-4b33-aa22-872572744411",
    "negotiation_budget": 100,
    "increase_by_percent": 10,
    "increase_every": {
        "value": 1,
        "unit": "DAYS"
    },
    "start_date" : "2022-11-09T10:34:07.748+0000",
    "acceptable_pickup_days": 2,
    "acceptable_delivery_days": 1,
    "is_enabled": true
  }
]
```
```

--------------------------------

### Update Order with Venue Details (JSON Example)

Source: https://developer.superdispatch.com/release-notes

Example JSON payload demonstrating how to update an order, specifically focusing on pickup and delivery venue details. It includes fields for reusing existing customer/terminal information (`counterparty_guid`) and saving new ones (`save_as_new`, `save_as_new_contact`). It also shows the structure for venue details including `business_type` and contact information.

```json
{
  "pickup": {
    "counterparty_guid": "ef2818b8-a55e-436a-a61e-993ae0470928",
    "save_as_new": null,
    "save_as_new_contact": null,
    "venue": {
      "name": "First Choice",
      "business_type": "DEALER",
      "address": "7997 Hudson Street",
      "city": "Suffolk",
      "state": "VA",
      "zip": "23434",
      "contact_name": "Patricia Bennett",
      "contact_title": "Dispatcher",
      "contact_email": "mail@example.com",
      "contact_phone": "215-800-1859",
      "contact_mobile_phone": "412-452-2889"
    }
  },
  "delivery": {
    "counterparty_guid": "...",
    "save_as_new": null,
    "save_as_new_contact": null,
    "venue": {
      "name": "Another Venue",
      "business_type": "BUSINESS",
      "address": "123 Main St",
      "city": "Anytown",
      "state": "CA",
      "zip": "90210"
    }
  }
}
```

--------------------------------

### Update Price Negotiation - cURL

Source: https://developer.superdispatch.com/documentation/price-negotiation

Updates an existing price negotiation using its GUID. Allows modification of negotiation budget, increase percentage, increase frequency, start date, and acceptable pickup/delivery days. The start date cannot be earlier than the order creation date.

```cURL
curl -X PUT 'https://api.shipper.superdispatch.com/v1/public/orders/price_negotiations/{guid}' \
-h 'Authorization: Bearer <access_token>' \
-h 'Content-Type: application/json;charset=UTF-8' 
-d '{
    "negotiation_budget": 100,
    "increase_by_percent": 15,
    "increase_every": {
        "value": 1,
        "unit": "DAYS"
    },
    "start_date" : "2022-11-09T10:34:07.748+0000",
    "acceptable_pickup_days": 2,
    "acceptable_delivery_days": 1
}'
```

--------------------------------

### Create Price Negotiation - cURL

Source: https://developer.superdispatch.com/documentation/price-negotiation

Creates a new price negotiation for an order. Requires order GUID, negotiation budget, increase percentage, increase frequency, start date, and acceptable pickup/delivery days. The start date must not be earlier than the order creation date.

```cURL
curl -X POST 'https://api.shipper.superdispatch.com/v1/public/orders/price_negotiations' \
-h 'Authorization: Bearer <access_token>' \
-h 'Content-Type: application/json;charset=UTF-8' 
-d '{
    "order_guid": "86c18bc8-7d1f-4b33-aa22-872572744411",
    "negotiation_budget": 100,
    "increase_by_percent": 10,
    "increase_every": {
        "value": 1,
        "unit": "DAYS"
    },
    "start_date" : "2022-11-09T10:34:07.748+0000",
    "acceptable_pickup_days": 2,
    "acceptable_delivery_days": 1
}'
```

--------------------------------

### Submit Order to Multiple Brokers

Source: https://developer.superdispatch.com/release-notes

This example demonstrates the expanded capability of the 'Submit order to the broker' endpoint. It shows how to specify the `broker_guid` field to submit an order to a specific broker when multiple connections are established. This provides greater flexibility in managing broker relationships.

```json
{
  "broker_guid": "{specific_broker_guid}",
  "...": "..."
}
```

--------------------------------

### Create Order using cURL

Source: https://developer.superdispatch.com/documentation/order-management

This snippet demonstrates how to create a new order via the Superdispatch API using a cURL command. It includes the necessary endpoint, headers, and a JSON payload with order details. The `number` field is mandatory, while other fields like `transport_type`, `price`, `customer`, `pickup`, and `delivery` provide comprehensive order information.

```bash
curl -X POST 'https://api.shipper.superdispatch.com/v1/public/orders' \
-h 'Authorization: Bearer <access_token>' \
-h 'Content-Type: application/json;charset=UTF-8' \
-d '{ \
    "number": "TST1267", \
    "transport_type": "OPEN", \
    "inspection_type": "standard", \
    "instructions": "Testing instructions for ABC", \
    "loadboard_instructions": "Testing Loadboard instructions", \
    "price": 200, \
    "dispatcher_name": "Vin Diesel", \
    "sales_representative": "Wilson Horn", \
    "broker_fee": 50, \
    "purchase_order_number": "PO-TST1267", \
    "payment": { \
        "terms": "other" \
    }, \
    "customer_payment": { \
        "cod_cop_amount": 0, \
        "tariff": 250, \
        "deposit": 100, \
        "terms": "cash_on_pickup", \
        "received_date": "2021-03-01T09:00:00.000-0600", \
        "reference_number": "123" \
    }, \
    "customer": { \
        "address": "14757 Sherman Way", \
        "name": "ABC", \
        "notes": null, \
        "state": "CA", \
        "zip": "91405", \
        "city": "Van Nuys", \
        "business_type": "BUSINESS", \
        "email": "dsf@example.com", \
        "phone": null, \
        "counterparty_guid": "7a71584f-9087-4e91-a9c5-202a537e27f6", \
        "save_as_new": false, \
        "contact_title": null, \
        "contact_email": "rbquinn91@example.com", \
        "contact_name": "Ross Bradley Quinn", \
        "contact_phone": "+1234567890", \
        "contact_mobile_phone": null \
    }, \
    "pickup": { \
        "date_type": "estimated", \
        "counterparty_guid": "3a7772a7-c3d3-4222-9741-1d969e706bd4", \
        "notes": null, \
        "first_available_pickup_date": "2021-03-01T09:00:00.000-0600", \
        "scheduled_at_by_customer": "2021-03-01T09:00:00.000-0600", \
        "scheduled_ends_at_by_customer": "2021-03-02T18:00:00.000-0600", \
        "scheduled_at": "2021-03-01T09:00:00.000-0600", \
        "scheduled_ends_at": "2021-03-02T18:00:00.000-0600", \
        "counterparty_guid": "5b5cf726-ded4-4f3d-8aa8-91b54b5bf61a", \
        "venue": { \
            "address": "3501 Lancaster Hutchins Rd", \
            "name": "AD Dallas", \
            "notes": null, \
            "state": "TX", \
            "zip": "75141", \
            "city": "Hutchins", \
            "business_type": "AUCTION", \
            "contact_title": "Manager", \
            "contact_email": null, \
            "contact_name": "John Marston", \
            "contact_phone": "+1234567890", \
            "contact_mobile_phone": null \
        } \
    }, \
    "delivery": { \
        "date_type": "estimated", \
        "counterparty_guid": "ee058e99-4c0e-4527-9943-7af1ce2605b1", \
        "notes": null, \
        "scheduled_at_by_customer": "2021-03-05T09:00:00.000-0600", \
        "scheduled_ends_at_by_customer": "2021-03-05T18:00:00.000-0600", \
        "scheduled_at": "2021-03-05T09:00:00.000-0600", \
        "scheduled_ends_at": "2021-03-05T18:00:00.000-0600", \
        "counterparty_guid": "bad0a6c5-3b93-40ef-9672-4e8cba3964d6", \
        "venue": { \
            "address": "2108 Ferguson Ln", \
            "name": "AD Austin", \
            "notes": null, \
            "state": "TX", \
            "zip": "78754", \
            "city": "Austin", \
            "business_type": "AUCTION", \
            "contact_title": "Gate Manager", \
            "contact_email": null, \
            "contact_name": "Arthur Morgan", \
            "contact_phone": "+1234567890", \
            "contact_mobile_phone": null \
        } \
    }, \
    "vehicles": [ \
        { \
            "vin": "JT3GM84R4Y0061930", \
            "curb_weight": 3440, \
            "curb_weight_unit": "lbs", \
            "make": "Toyota", \
            "model": "4Runner", \
            "color": null, \
            "type": "suv", \
            "year": 2000, \
            "price": 200, \
            "tariff": 250 \
        } \
    ] \
}'
```

--------------------------------

### Get Damage by ID API Response Example

Source: https://developer.superdispatch.com/release-notes/epod-sync-fields-updates

This JSON object illustrates a successful response from the Get Damage by ID API. It contains metadata and a single damage object, including its 'id', 'code', 'notes', and the 'step' field indicating the stage of the process.

```json
{
    "meta": {
        "code": 200,
        "request_id": "6b084923-...-6bd7f1a95830"
    },
    "data": {
        "id": 1,
        "code": "BR",
        "notes": "Some note 1",
        "step": "delivery"
    }
}
```