openapi: 3.0.2 info: title: Shipper API termsOfService: "https://www.superdispatch.com/terms-of-service" contact: name: API Support url: "https://developer.superdispatch.com" email: support@superdispatch.com version: 1.0.0 description: | The Shipper API allows customers to interact with the Shipper TMS and Carrier TMS to build custom solutions: create and manage orders, assign them to carriers, get updates (ePOD) etc. servers: - url: "https://api.shipper.superdispatch.com/v1/public" description: The Production (live) server components: securitySchemes: oauth2: type: oauth2 flows: clientCredentials: tokenUrl: /oauth/token?grant_type=client_credentials scopes: {} basicAuth: type: http scheme: basic parameters: order_guid: name: order_guid description: Order GUID in: path required: true schema: type: string format: uuid example: ef2818b8-a55e-436a-a61e-993ae0470928 vehicle_guid: name: vehicle_guid description: Vehicle GUID in: path required: true schema: type: string format: uuid example: cf175584-ed21-4a22-8474-7f44d413be22 request_guid: name: request_guid description: Load Request GUID in: path required: true schema: type: string format: uuid example: ef2818b8-a55e-436a-a61e-470928993ae0 customer_guid: name: customer_guid description: Customer GUID in: path required: true schema: type: string format: uuid example: ef2818b8-a55e-436a-a61e-993ae0470928 terminal_guid: name: terminal_guid description: Terminal GUID in: path required: true schema: type: string format: uuid example: ef2818b8-a55e-436a-a61e-993ae0470928 carrier_query: name: query description: "US DOT, name, or email of a carrier. The carrier name can be partial." in: query schema: type: string examples: us_dot: value: "00000" summary: US DOT carrier_name: value: dispatch summary: Name email: value: mail@example.com summary: Email carrier_usdot: name: usdot in: query required: false schema: type: string carrier_mcNumber: name: mcNumber in: query required: false schema: type: string carrier_name: name: name description: The carrier name can be partial. in: query required: false schema: type: string carrier_email: name: email in: query required: false schema: type: string carrier_phone: name: phone in: query required: false schema: type: string start_date: name: start_date in: query required: true schema: type: string format: date-time example: "2020-02-15T00:00:00.112+0000" end_date: name: end_date in: query required: true schema: type: string format: date-time example: "2020-02-23T00:00:00.112+0000" pickup_address: name: pickup_address in: query required: true schema: type: string example: "NYC, NY" delivery_address: name: delivery_address in: query required: true schema: type: string example: "Las Vegas, NV" custom_external_id: name: custom_external_id in: path required: true schema: type: string example: CUSTOM-334 responses: AuthenticationSuccessResponse: description: Successfully authenticated content: application/json: schema: type: object properties: access_token: type: string description: Access token example: UzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsiQlRNUyIsIlNMQiJdLCJzdWIiOiI0ZTMxZWRjZi03NjhjLTQ3NjYtOGQxOC1iMDIzYTFkY2MwODYiLCJvcmdfZ3VpZCI6ImRmYmUyOThhLWE3YmQtNGJiMi1iYzQ4LWQ0YTUxMmMyYTU5MiIsInB1cnBvc2UiOiJwdWJsaWNfYnJva2VyX2FwaSIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdLCJpc3MiOiJCVE1TIiwiZXhwIjoxNTczODM3OTgyLCJpYX token_type: type: string example: bearer expires_in: type: number format: int64 example: 863999 scope: type: string example: read write aud: type: array items: type: string example: - BTMS - SLB sub: type: string format: uuid org_guid: type: string format: uuid purpose: type: string example: public_broker_api iss: type: string example: BTMS iat: type: number format: int64 example: 1572973982 jti: type: string format: uuid AuthenticationFailedResponse: description: Authentication failed content: application/json: schema: type: object properties: timestamp: type: string format: date-time status: type: number format: int example: 401 error: type: string example: Unauthorized message: type: string example: Unauthorized path: type: string example: /oauth/token AuthenticationValidationErrorResponse: description: Validation error content: application/json: schema: type: object properties: error: type: string example: invalid_request error_description: type: string example: Missing grant type BaseResponse: description: Base response object content: application/json: schema: type: object properties: status: type: string enum: - success - fail data: type: object ErrorResponse: description: An error response is returned content: application/json: schema: type: object properties: status: type: string enum: - fail - success default: fail data: type: object properties: error_id: type: string description: "The error code like `NOT_FOUND`, `AUTH_ERROR`" message: type: string description: A human readable message details: type: object nullable: true description: Additional details like *validation* CustomerDetailsResponse: description: Customer details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema" CustomerListResponse: description: A list of objects content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: objects: type: array items: $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema" pagination: $ref: "#/components/responses/WebhooksResponse/content/application~1json/schema/allOf/1/properties/data/properties/pagination" TerminalDetailsResponse: description: Terminal details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: $ref: "#/paths/~1terminals/post/requestBody/content/application~1json/schema" TerminalListResponse: description: A list of objects content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: objects: type: array items: $ref: "#/paths/~1terminals/post/requestBody/content/application~1json/schema" pagination: $ref: "#/components/responses/WebhooksResponse/content/application~1json/schema/allOf/1/properties/data/properties/pagination" ContactDetailsResponse: description: Contact details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: $ref: "#/paths/~1customers~1%7Bcustomer_guid%7D~1contacts/post/requestBody/content/application~1json/schema" ContactListResponse: description: A list of objects content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: objects: type: array items: $ref: "#/paths/~1customers~1%7Bcustomer_guid%7D~1contacts/post/requestBody/content/application~1json/schema" pagination: $ref: "#/components/responses/WebhooksResponse/content/application~1json/schema/allOf/1/properties/data/properties/pagination" CarrierDetailsResponse: description: Carrier details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - $ref: "#/paths/~1terminals/post/requestBody/content/application~1json/schema/allOf/1" - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/2" CarrierListResponse: description: A list of objects content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: objects: type: array items: $ref: "#/components/responses/CarrierDetailsResponse/content/application~1json/schema/allOf/1/properties/data/properties/object" pagination: $ref: "#/components/responses/WebhooksResponse/content/application~1json/schema/allOf/1/properties/data/properties/pagination" CarrierWithDetailsResponse: description: Carrier details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: $ref: "#/paths/~1carriers~1internal/post/requestBody/content/application~1json/schema" CarrierListWithDetailsResponse: description: List of carriers with full details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: objects: type: array items: $ref: "#/paths/~1carriers~1internal/post/requestBody/content/application~1json/schema" pagination: type: object properties: total_pages: type: integer format: int32 description: The number of pages total_objects: type: integer format: int64 description: The total number of objects found limit: type: integer format: int32 default: 25 description: The number of objects per page page: type: integer format: int32 description: The current page index CarrierFromFMCSAListWithDetailsResponse: description: List of carriers with full details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: objects: type: array items: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - type: object required: - name properties: name: type: string example: First Rate Choice email: type: string format: email nullable: true dba_name: type: string nullable: true example: FIRST RATE CHOICE phone_numbers: type: string nullable: true example: 202-555-0173 fax: type: string nullable: true example: 573-291-1978 website: type: string nullable: true format: hostname contact_name: type: string nullable: true example: Karen Rodriguez w9: type: string format: uri readOnly: true nullable: true example: "https://superdispatch-attachments.s3.amazonaws.com/files/carriers/ea0f383a5a7146e48f2136dd3ee38f83/w9.jpeg" usdot_certificate: type: string format: uri readOnly: true nullable: true example: "https://superdispatch-attachments.s3.amazonaws.com/files/carriers/ea0f383a5a7146e48f2136dd3ee38f83/usdot-certificate.jpeg" cargo_insurance: type: string format: uri readOnly: true nullable: true example: "https://superdispatch-attachments.s3.amazonaws.com/files/carriers/ea0f383a5a7146e48f2136dd3ee38f83/cargo-insurance.pdf" mc_number: type: string readOnly: true nullable: true us_dot: type: string readOnly: true nullable: true cargo_policy: $ref: "#/paths/~1terminals/post/requestBody/content/application~1json/schema/allOf/1/properties/cargo_policy" readOnly: true nullable: true - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/2" - type: object properties: carrier_type: type: string enum: - CTMS - INTERNAL - FMCSA readOnly: true description: "The carrier type: `CTMS` is a real carrier that uses Carrier TMS, `INTERNAL` is a carrier managed only on Shipper TMS, `FMCSA` is a carrier that exists in the FMCSA database" broker_records: $ref: "#/paths/~1carriers~1%7Bguid%7D~1profile/put/requestBody/content/application~1json/schema" description: Custom records saved for this specific carrier. This information is not available for carriers on Carrier TMS. pagination: $ref: "#/components/responses/CarrierListWithDetailsResponse/content/application~1json/schema/allOf/1/properties/data/properties/pagination" ApprovedCarrierListWithDetailsResponse: description: List of carriers with full details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: objects: type: array items: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - $ref: "#/paths/~1terminals/post/requestBody/content/application~1json/schema/allOf/1" - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/2" - type: object properties: carrier_type: type: string enum: - CTMS - INTERNAL - FMCSA readOnly: true description: "The carrier type: `CTMS` is a real carrier that uses Carrier TMS, `INTERNAL` is a carrier managed only on Shipper TMS, `FMCSA` is a carrier that exists in the FMCSA database" broker_records: description: Custom records saved for this specific carrier. This information is not available for carriers on Carrier TMS. type: object readOnly: true properties: guid: type: string format: uuid readOnly: true example: 4f797316-63a8-432a-a4ef-2986b8occ89d usdot_number: type: string nullable: true example: "03324" approved: type: boolean default: true description: "Approved carrier status helps shippers differentiate carriers who they have verified, onboarded, and/or have done business with. A carrier cannot be Approved and Blacklisted at the same time." approved_since: type: string format: date-time readOnly: true nullable: true default: null example: "2019-11-15T10:33:29.112+0000" preferred: type: boolean default: false description: Preferred status allows the carrier to instantly book loads posted by the shipper in the Super Loadboard. Carrier will automatically become approved once it's marked as preferred. preferred_since: type: string format: date-time readOnly: true nullable: true default: null example: null in_blacklist: type: boolean default: false description: It indicates an issue with the carrier and does not allow the carrier to book or request any loads inside the Super Loadboard. A carrier cannot be Approved and Blacklisted at the same time. in_blacklist_since: type: string format: date-time readOnly: true nullable: true default: null example: null insurance_certificate_holder: type: boolean default: false description: Marks the carrier as a Certificate Holder. insurance_certificate_holder_since: type: string format: date-time readOnly: true nullable: true default: null insurance_cert_holder_file_url: type: string format: uri readOnly: true nullable: true default: null example: "https://superdispatch-attachments.s3.amazonaws.com/files/carriers/ea0f383a5a7146e48f2136dd3ee38f83/insurance-cert-holder.pdf" insurance_expires_at: type: string format: date nullable: true default: null custom_external_id: type: string nullable: true default: null example: CARRIER-0098 pagination: $ref: "#/components/responses/CarrierListWithDetailsResponse/content/application~1json/schema/allOf/1/properties/data/properties/pagination" CertHolderCarrierListWithDetailsResponse: description: List of carriers with full details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: objects: type: array items: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - $ref: "#/paths/~1terminals/post/requestBody/content/application~1json/schema/allOf/1" - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/2" - type: object properties: carrier_type: type: string enum: - CTMS - INTERNAL - FMCSA readOnly: true description: "The carrier type: `CTMS` is a real carrier that uses Carrier TMS, `INTERNAL` is a carrier managed only on Shipper TMS, `FMCSA` is a carrier that exists in the FMCSA database" broker_records: description: Custom records saved for this specific carrier. This information is not available for carriers on Carrier TMS. type: object readOnly: true properties: guid: type: string format: uuid readOnly: true example: 4f797316-63a8-432a-a4ef-2986b8occ89d usdot_number: type: string nullable: true example: "03324" approved: type: boolean default: true description: "Approved carrier status helps shippers differentiate carriers who they have verified, onboarded, and/or have done business with. A carrier cannot be Approved and Blacklisted at the same time." approved_since: type: string format: date-time readOnly: true nullable: true default: null example: "2019-11-15T10:33:29.112+0000" preferred: type: boolean default: false description: Preferred status allows the carrier to instantly book loads posted by the shipper in the Super Loadboard. Carrier will automatically become approved once it's marked as preferred. preferred_since: type: string format: date-time readOnly: true nullable: true default: null example: null in_blacklist: type: boolean default: false description: It indicates an issue with the carrier and does not allow the carrier to book or request any loads inside the Super Loadboard. A carrier cannot be Approved and Blacklisted at the same time. in_blacklist_since: type: string format: date-time readOnly: true nullable: true default: null example: null insurance_certificate_holder: type: boolean default: true description: Marks the carrier as a Certificate Holder. insurance_certificate_holder_since: type: string format: date-time readOnly: true nullable: true default: null example: "2019-11-15T10:33:29.112+0000" insurance_cert_holder_file_url: type: string format: uri readOnly: true nullable: true default: null example: "https://superdispatch-attachments.s3.amazonaws.com/files/carriers/ea0f383a5a7146e48f2136dd3ee38f83/insurance-cert-holder.pdf" insurance_expires_at: type: string format: date nullable: true default: null custom_external_id: type: string nullable: true default: null example: CARRIER-0098 pagination: $ref: "#/components/responses/CarrierListWithDetailsResponse/content/application~1json/schema/allOf/1/properties/data/properties/pagination" PreferredCarrierListWithDetailsResponse: description: List of carriers with full details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: objects: type: array items: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - $ref: "#/paths/~1terminals/post/requestBody/content/application~1json/schema/allOf/1" - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/2" - type: object properties: carrier_type: type: string enum: - CTMS - INTERNAL - FMCSA readOnly: true description: "The carrier type: `CTMS` is a real carrier that uses Carrier TMS, `INTERNAL` is a carrier managed only on Shipper TMS, `FMCSA` is a carrier that exists in the FMCSA database" broker_records: description: Custom records saved for this specific carrier. This information is not available for carriers on Carrier TMS. type: object readOnly: true properties: guid: type: string format: uuid readOnly: true example: 4f797316-63a8-432a-a4ef-2986b8occ89d usdot_number: type: string nullable: true example: "03324" approved: type: boolean default: true description: "Approved carrier status helps shippers differentiate carriers who they have verified, onboarded, and/or have done business with. A carrier cannot be Approved and Blacklisted at the same time." approved_since: type: string format: date-time readOnly: true nullable: true default: null example: "2019-11-15T10:33:29.112+0000" preferred: type: boolean default: true description: Preferred status allows the carrier to instantly book loads posted by the shipper in the Super Loadboard. Carrier will automatically become approved once it's marked as preferred. preferred_since: type: string format: date-time readOnly: true nullable: true default: null example: "2019-11-15T10:33:29.112+0000" in_blacklist: type: boolean default: false description: It indicates an issue with the carrier and does not allow the carrier to book or request any loads inside the Super Loadboard. A carrier cannot be Approved and Blacklisted at the same time. in_blacklist_since: type: string format: date-time readOnly: true nullable: true default: null example: null insurance_certificate_holder: type: boolean default: false description: Marks the carrier as a Certificate Holder. insurance_certificate_holder_since: type: string format: date-time readOnly: true nullable: true default: null example: null insurance_cert_holder_file_url: type: string format: uri readOnly: true nullable: true default: null example: "https://superdispatch-attachments.s3.amazonaws.com/files/carriers/ea0f383a5a7146e48f2136dd3ee38f83/insurance-cert-holder.pdf" insurance_expires_at: type: string format: date nullable: true default: null custom_external_id: type: string nullable: true default: null example: CARRIER-0098 pagination: $ref: "#/components/responses/CarrierListWithDetailsResponse/content/application~1json/schema/allOf/1/properties/data/properties/pagination" BlacklistedCarrierListWithDetailsResponse: description: List of carriers with full details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: objects: type: array items: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - $ref: "#/paths/~1terminals/post/requestBody/content/application~1json/schema/allOf/1" - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/2" - type: object properties: carrier_type: type: string enum: - CTMS - INTERNAL - FMCSA readOnly: true description: "The carrier type: `CTMS` is a real carrier that uses Carrier TMS, `INTERNAL` is a carrier managed only on Shipper TMS, `FMCSA` is a carrier that exists in the FMCSA database" broker_records: description: Custom records saved for this specific carrier. This information is not available for carriers on Carrier TMS. type: object readOnly: true properties: guid: type: string format: uuid readOnly: true example: 4f797316-63a8-432a-a4ef-2986b8occ89d usdot_number: type: string nullable: true example: "03324" approved: type: boolean default: false description: "Approved carrier status helps shippers differentiate carriers who they have verified, onboarded, and/or have done business with. A carrier cannot be Approved and Blacklisted at the same time." approved_since: type: string format: date-time readOnly: true nullable: true default: null example: null preferred: type: boolean default: false description: Preferred status allows the carrier to instantly book loads posted by the shipper in the Super Loadboard. Carrier will automatically become approved once it's marked as preferred. preferred_since: type: string format: date-time readOnly: true nullable: true default: null example: null in_blacklist: type: boolean default: true description: It indicates an issue with the carrier and does not allow the carrier to book or request any loads inside the Super Loadboard. A carrier cannot be Approved and Blacklisted at the same time. in_blacklist_since: type: string format: date-time readOnly: true nullable: true default: null example: "2019-11-15T10:33:29.112+0000" insurance_certificate_holder: type: boolean default: false description: Marks the carrier as a Certificate Holder. insurance_certificate_holder_since: type: string format: date-time readOnly: true nullable: true default: null example: null insurance_cert_holder_file_url: type: string format: uri readOnly: true nullable: true default: null example: "https://superdispatch-attachments.s3.amazonaws.com/files/carriers/ea0f383a5a7146e48f2136dd3ee38f83/insurance-cert-holder.pdf" insurance_expires_at: type: string format: date nullable: true default: null custom_external_id: type: string nullable: true default: null example: CARRIER-0098 pagination: $ref: "#/components/responses/CarrierListWithDetailsResponse/content/application~1json/schema/allOf/1/properties/data/properties/pagination" CarrierNoteResponse: description: Carrier note content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: $ref: "#/paths/~1carriers~1%7Bguid%7D~1notes/post/requestBody/content/application~1json/schema" OrderDetailsResponseUpdatedPartially: description: Order details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/0" - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - $ref: "#/components/responses/CanceledOrderResponse/content/application~1json/schema/allOf/1/properties/data/properties/object/allOf/2" - type: object properties: number: type: string description: The order number that is used for invoicing or dispatching example: ORDER-4532 inspection_type: type: string enum: - standard - advanced - aiag description: "Different types of inspection. `standard` is a default inspection process that drivers perform on the mobile app. `advanced` requires the driver to add at least 6 photos, and have location information and geotagging enabled on their mobile app. `aiag` requires the driver to mark damages with AIAG Inspection Standard codes and take 2 photos. Read more: https://support.superdispatch.com/hc/en-us/articles/37239414473619-Inspection-Type-Options" status: type: string enum: - new - pending - accepted - canceled - declined - picked_up - delivered - invoiced - paid - order_canceled description: The order status is_status_changed_manually: type: boolean readOnly: true default: false purchase_order_number: type: string default: null nullable: true example: PO 0006 dispatcher_name: type: string nullable: true example: Sherry Turner dispatcher: $ref: "#/components/responses/CanceledOrderResponse/content/application~1json/schema/allOf/1/properties/data/properties/object/allOf/3/properties/dispatcher" sales_representative: type: string nullable: true example: Alma Dubois price: type: number format: float nullable: true example: 325 price_per_km: type: number format: float nullable: true readOnly: true example: 2 is_posted_to_loadboard: type: boolean readOnly: true default: false posted_to_loadboard_at: type: string format: date-time nullable: true readOnly: true example: "2019-11-15T10:33:29.112+0000" is_flagged: type: boolean readOnly: true default: false is_on_hold: type: boolean readOnly: true default: false broker_fee: type: number format: float nullable: true example: 50 instructions: type: string nullable: true loadboard_instructions: type: string nullable: true payment: $ref: "#/paths/~1orders~1%7Bguid%7D~1mark_as_paid/put/requestBody/content/application~1json/schema" customer_payment: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/customer_payment" pickup: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/pickup" delivery: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/delivery" customer: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/customer" dispatch_sheet_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../dispatch-sheet.pdf" pdf_bol_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/BOL.pdf" pdf_bol_url_with_template: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/BOL.pdf" pdf_delivery_receipt_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/delivery-receipt.pdf" online_bol_url: type: string format: uri readOnly: true nullable: true example: "https://bol.superdispatch.com/f0446d" vehicles: type: array items: $ref: "#/paths/~1orders~1%7Border_guid%7D~1vehicles/post/requestBody/content/application~1json/schema" distance_meters: type: number format: float readOnly: true distance_duration_seconds: type: number format: int64 readOnly: true transport_type: type: string enum: - OPEN - ENCLOSED - DRIVEAWAY default: OPEN OrderDetailsResponseAcceptedManually: description: Order details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/0" - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - $ref: "#/components/responses/CanceledOrderResponse/content/application~1json/schema/allOf/1/properties/data/properties/object/allOf/2" - type: object required: - number properties: number: type: string description: The order number that is used for invoicing or dispatching example: ORDER-4532 inspection_type: type: string enum: - standard - advanced - aiag description: "Different types of inspection. `standard` is a default inspection process that drivers perform on the mobile app. `advanced` requires the driver to add at least 6 photos, and have location information and geotagging enabled on their mobile app. `aiag` requires the driver to mark damages with AIAG Inspection Standard codes and take 2 photos. Read more: https://support.superdispatch.com/hc/en-us/articles/37239414473619-Inspection-Type-Options" status: type: string enum: - accepted - pending - new - canceled - declined - picked_up - delivered - invoiced - paid - order_canceled description: The order status is_status_changed_manually: type: boolean readOnly: true default: true purchase_order_number: type: string default: null nullable: true example: PO 0006 dispatcher_name: type: string nullable: true example: Sherry Turner dispatcher: $ref: "#/components/responses/CanceledOrderResponse/content/application~1json/schema/allOf/1/properties/data/properties/object/allOf/3/properties/dispatcher" sales_representative: type: string nullable: true example: Alma Dubois price: type: number format: float nullable: true example: 325 price_per_km: type: number format: float nullable: true readOnly: true example: 2 is_posted_to_loadboard: type: boolean readOnly: true default: false posted_to_loadboard_at: type: string format: date-time nullable: true readOnly: true example: "2019-11-15T10:33:29.112+0000" is_flagged: type: boolean readOnly: true default: false is_on_hold: type: boolean readOnly: true default: false broker_fee: type: number format: float nullable: true example: 50 instructions: type: string nullable: true loadboard_instructions: type: string nullable: true payment: $ref: "#/paths/~1orders~1%7Bguid%7D~1mark_as_paid/put/requestBody/content/application~1json/schema" customer_payment: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/customer_payment" pickup: type: object properties: first_available_pickup_date: type: string format: date-time nullable: true example: "2019-11-20T10:33:29.112+0000" scheduled_at: type: string format: date-time nullable: true example: "2019-11-20T10:33:29.112+0000" scheduled_ends_at: type: string format: date-time nullable: true example: "2019-11-22T10:33:29.112+0000" scheduled_at_by_customer: type: string format: date-time nullable: true example: "2019-11-20T10:33:29.112+0000" scheduled_ends_at_by_customer: type: string format: date-time nullable: true example: "2019-11-20T10:33:29.112+0000" scheduled_at_by_carrier: type: string format: date-time nullable: true readOnly: true example: "2019-11-15T10:33:29.112+0000" description: The updated date set by the carrier adjusted_date: type: string format: date-time nullable: true example: null notes: type: string nullable: true date_type: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/pickup/properties/date_type" completed_at: type: string format: date-time nullable: true readOnly: true example: null counterparty_guid: type: string format: uuid nullable: true description: "The `guid` of a customer or terminal to reuse their existing information. If `counterparty_guid` is specified and all other information omitted, all terminal information will be automatically filled by the system." example: 4f797316-63a8-432a-a4ef-2986b8occ89d save_as_new: type: boolean default: null nullable: true description: Save the information in `venue` as a terminal save_as_new_contact: type: boolean default: null nullable: true description: Save the information in `venue` as a new contact of the current terminal or customer (based on `counterparty_guid`) venue: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/pickup/properties/venue" delivery: type: object properties: scheduled_at: type: string format: date-time nullable: true example: "2019-11-20T10:33:29.112+0000" scheduled_ends_at: type: string format: date-time nullable: true example: "2019-11-22T10:33:29.112+0000" scheduled_at_by_customer: type: string format: date-time nullable: true example: "2019-11-20T10:33:29.112+0000" scheduled_ends_at_by_customer: type: string format: date-time nullable: true example: "2019-11-20T10:33:29.112+0000" scheduled_at_by_carrier: type: string format: date-time nullable: true readOnly: true example: "2019-11-15T10:33:29.112+0000" description: The updated date set by the carrier adjusted_date: type: string format: date-time nullable: true example: null notes: type: string nullable: true date_type: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/pickup/properties/date_type" completed_at: type: string format: date-time nullable: true readOnly: true example: null counterparty_guid: type: string format: uuid nullable: true description: "The `guid` of a customer or terminal to reuse their existing information. If `counterparty_guid` is specified and all other information omitted, all terminal information will be automatically filled by the system." example: 4f797316-63a8-432a-a4ef-2986b8occ89d save_as_new: type: boolean default: null nullable: true description: Save the information in `venue` as a terminal save_as_new_contact: type: boolean default: null nullable: true description: Save the information in `venue` as a new contact of the current terminal or customer (based on `counterparty_guid`) venue: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/pickup/properties/venue" customer: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/customer" dispatch_sheet_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../dispatch-sheet.pdf" pdf_bol_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/BOL.pdf" pdf_bol_url_with_template: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/BOL.pdf" pdf_delivery_receipt_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/delivery-receipt.pdf" online_bol_url: type: string format: uri readOnly: true nullable: true example: "https://bol.superdispatch.com/f0446d" vehicles: type: array items: $ref: "#/paths/~1orders~1%7Border_guid%7D~1vehicles/post/requestBody/content/application~1json/schema" distance_meters: type: number format: float readOnly: true distance_duration_seconds: type: number format: int64 readOnly: true transport_type: type: string enum: - OPEN - ENCLOSED - DRIVEAWAY default: OPEN OrderDetailsResponsePickedUpManually: description: Order details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/0" - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - $ref: "#/components/responses/CanceledOrderResponse/content/application~1json/schema/allOf/1/properties/data/properties/object/allOf/2" - type: object required: - number properties: number: type: string description: The order number that is used for invoicing or dispatching example: ORDER-4532 inspection_type: type: string enum: - standard - advanced - aiag description: "Different types of inspection. `standard` is a default inspection process that drivers perform on the mobile app. `advanced` requires the driver to add at least 6 photos, and have location information and geotagging enabled on their mobile app. `aiag` requires the driver to mark damages with AIAG Inspection Standard codes and take 2 photos. Read more: https://support.superdispatch.com/hc/en-us/articles/37239414473619-Inspection-Type-Options" status: type: string enum: - picked_up - pending - new - canceled - declined - accepted - delivered - invoiced - paid - order_canceled description: The order status is_status_changed_manually: type: boolean readOnly: true default: true purchase_order_number: type: string default: null nullable: true example: PO 0006 dispatcher_name: type: string nullable: true example: Sherry Turner dispatcher: $ref: "#/components/responses/CanceledOrderResponse/content/application~1json/schema/allOf/1/properties/data/properties/object/allOf/3/properties/dispatcher" sales_representative: type: string nullable: true example: Alma Dubois price: type: number format: float nullable: true example: 325 price_per_km: type: number format: float nullable: true readOnly: true example: 2 is_posted_to_loadboard: type: boolean readOnly: true default: false posted_to_loadboard_at: type: string format: date-time nullable: true readOnly: true example: "2019-11-15T10:33:29.112+0000" is_flagged: type: boolean readOnly: true default: false is_on_hold: type: boolean readOnly: true default: false broker_fee: type: number format: float nullable: true example: 50 instructions: type: string nullable: true loadboard_instructions: type: string nullable: true payment: $ref: "#/paths/~1orders~1%7Bguid%7D~1mark_as_paid/put/requestBody/content/application~1json/schema" customer_payment: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/customer_payment" pickup: $ref: "#/components/responses/OrderDetailsResponseUnmarkedAsPaid/content/application~1json/schema/allOf/1/properties/data/properties/object/allOf/3/properties/pickup" delivery: $ref: "#/components/responses/OrderDetailsResponseAcceptedManually/content/application~1json/schema/allOf/1/properties/data/properties/object/allOf/3/properties/delivery" customer: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/customer" dispatch_sheet_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../dispatch-sheet.pdf" pdf_bol_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/BOL.pdf" pdf_bol_url_with_template: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/BOL.pdf" pdf_delivery_receipt_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/delivery-receipt.pdf" online_bol_url: type: string format: uri readOnly: true nullable: true example: "https://bol.superdispatch.com/f0446d" vehicles: type: array items: $ref: "#/paths/~1orders~1%7Border_guid%7D~1vehicles/post/requestBody/content/application~1json/schema" distance_meters: type: number format: float readOnly: true distance_duration_seconds: type: number format: int64 readOnly: true transport_type: type: string enum: - OPEN - ENCLOSED - DRIVEAWAY default: OPEN OrderDetailsResponseDeliveredManually: description: Order details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/0" - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - $ref: "#/components/responses/CanceledOrderResponse/content/application~1json/schema/allOf/1/properties/data/properties/object/allOf/2" - type: object required: - number properties: number: type: string description: The order number that is used for invoicing or dispatching example: ORDER-4532 inspection_type: type: string enum: - standard - advanced - aiag description: "Different types of inspection. `standard` is a default inspection process that drivers perform on the mobile app. `advanced` requires the driver to add at least 6 photos, and have location information and geotagging enabled on their mobile app. `aiag` requires the driver to mark damages with AIAG Inspection Standard codes and take 2 photos. Read more: https://support.superdispatch.com/hc/en-us/articles/37239414473619-Inspection-Type-Options" status: type: string enum: - delivered - picked_up - pending - new - canceled - declined - accepted - delivered - invoiced - paid - order_canceled description: The order status is_status_changed_manually: type: boolean readOnly: true default: true purchase_order_number: type: string default: null nullable: true example: PO 0006 dispatcher_name: type: string nullable: true example: Sherry Turner dispatcher: $ref: "#/components/responses/CanceledOrderResponse/content/application~1json/schema/allOf/1/properties/data/properties/object/allOf/3/properties/dispatcher" sales_representative: type: string nullable: true example: Alma Dubois price: type: number format: float nullable: true example: 325 price_per_km: type: number format: float nullable: true readOnly: true example: 2 is_posted_to_loadboard: type: boolean readOnly: true default: false posted_to_loadboard_at: type: string format: date-time nullable: true readOnly: true example: "2019-11-15T10:33:29.112+0000" is_flagged: type: boolean readOnly: true default: false is_on_hold: type: boolean readOnly: true default: false broker_fee: type: number format: float nullable: true example: 50 instructions: type: string nullable: true loadboard_instructions: type: string nullable: true payment: $ref: "#/paths/~1orders~1%7Bguid%7D~1mark_as_paid/put/requestBody/content/application~1json/schema" customer_payment: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/customer_payment" pickup: $ref: "#/components/responses/OrderDetailsResponseUnmarkedAsPaid/content/application~1json/schema/allOf/1/properties/data/properties/object/allOf/3/properties/pickup" delivery: $ref: "#/components/responses/OrderDetailsResponseUnmarkedAsPaid/content/application~1json/schema/allOf/1/properties/data/properties/object/allOf/3/properties/delivery" customer: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/customer" dispatch_sheet_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../dispatch-sheet.pdf" pdf_bol_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/BOL.pdf" pdf_bol_url_with_template: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/BOL.pdf" pdf_delivery_receipt_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/delivery-receipt.pdf" online_bol_url: type: string format: uri readOnly: true nullable: true example: "https://bol.superdispatch.com/f0446d" vehicles: type: array items: $ref: "#/paths/~1orders~1%7Border_guid%7D~1vehicles/post/requestBody/content/application~1json/schema" distance_meters: type: number format: float readOnly: true distance_duration_seconds: type: number format: int64 readOnly: true transport_type: type: string enum: - OPEN - ENCLOSED - DRIVEAWAY default: OPEN OrderDetailsResponseInvoicedManually: description: Order details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/0" - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - $ref: "#/components/responses/CanceledOrderResponse/content/application~1json/schema/allOf/1/properties/data/properties/object/allOf/2" - $ref: "#/paths/~1orders/get/responses/200/content/application~1json/schema/allOf/1/properties/data/properties/object" - type: object properties: invoice: type: array items: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/invoice" OrderDetailsResponseRollbackManually: description: Order details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/0" - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - $ref: "#/components/responses/CanceledOrderResponse/content/application~1json/schema/allOf/1/properties/data/properties/object/allOf/2" - $ref: "#/paths/~1orders/get/responses/200/content/application~1json/schema/allOf/1/properties/data/properties/object" - type: object properties: invoice: type: array items: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/invoice" OrderDetailsResponseUnmarkedAsPaid: description: Order details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/0" - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - $ref: "#/components/responses/CanceledOrderResponse/content/application~1json/schema/allOf/1/properties/data/properties/object/allOf/2" - type: object required: - number properties: number: type: string description: The order number that is used for invoicing or dispatching example: ORDER-4532 inspection_type: type: string enum: - standard - advanced - aiag description: "Different types of inspection. `standard` is a default inspection process that drivers perform on the mobile app. `advanced` requires the driver to add at least 6 photos, and have location information and geotagging enabled on their mobile app. `aiag` requires the driver to mark damages with AIAG Inspection Standard codes and take 2 photos. Read more: https://support.superdispatch.com/hc/en-us/articles/37239414473619-Inspection-Type-Options" status: type: string enum: - delivered - picked_up - pending - new - canceled - declined - accepted - delivered - invoiced - paid - order_canceled description: The order status is_status_changed_manually: type: boolean readOnly: true default: true purchase_order_number: type: string default: null nullable: true example: PO 0006 dispatcher_name: type: string nullable: true example: Sherry Turner dispatcher: $ref: "#/components/responses/CanceledOrderResponse/content/application~1json/schema/allOf/1/properties/data/properties/object/allOf/3/properties/dispatcher" sales_representative: type: string nullable: true example: Alma Dubois price: type: number format: float nullable: true example: 325 price_per_km: type: number format: float nullable: true readOnly: true example: 2 is_posted_to_loadboard: type: boolean readOnly: true default: false posted_to_loadboard_at: type: string format: date-time nullable: true readOnly: true example: "2019-11-15T10:33:29.112+0000" is_flagged: type: boolean readOnly: true default: false is_on_hold: type: boolean readOnly: true default: false broker_fee: type: number format: float nullable: true example: 50 instructions: type: string nullable: true loadboard_instructions: type: string nullable: true payment: type: object properties: terms: type: string enum: - 2_days - 5_days - 7_days - 10_days - 15_days - 20_days - 30_days - 40_days - 45_days - ach - on_pickip - on_delivery - cash_on_pickup - check_on_pickup - cash_on_delivery - check_on_delivery - comchek - quick_pay - other nullable: true notes: type: string nullable: true default: null method: type: string enum: - cash - check - cashiers_check - money_order - comchek - credit_card - direct_deposit - other nullable: true default: null amount: type: number format: float nullable: true default: null reference_number: type: string nullable: true default: null sent_date: type: string format: date-time nullable: true default: null customer_payment: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/customer_payment" pickup: type: object properties: first_available_pickup_date: type: string format: date-time nullable: true example: "2019-11-20T10:33:29.112+0000" scheduled_at: type: string format: date-time nullable: true example: "2019-11-20T10:33:29.112+0000" scheduled_ends_at: type: string format: date-time nullable: true example: "2019-11-22T10:33:29.112+0000" scheduled_at_by_customer: type: string format: date-time nullable: true example: "2019-11-20T10:33:29.112+0000" scheduled_ends_at_by_customer: type: string format: date-time nullable: true example: "2019-11-20T10:33:29.112+0000" scheduled_at_by_carrier: type: string format: date-time nullable: true readOnly: true example: "2019-11-15T10:33:29.112+0000" description: The updated date set by the carrier adjusted_date: type: string format: date-time nullable: true example: "2019-11-19T10:33:29.112+0000" notes: type: string nullable: true date_type: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/pickup/properties/date_type" completed_at: type: string format: date-time nullable: true readOnly: true example: null counterparty_guid: type: string format: uuid nullable: true description: "The `guid` of a customer or terminal to reuse their existing information. If `counterparty_guid` is specified and all other information omitted, all terminal information will be automatically filled by the system." example: 4f797316-63a8-432a-a4ef-2986b8occ89d save_as_new: type: boolean default: null nullable: true description: Save the information in `venue` as a terminal save_as_new_contact: type: boolean default: null nullable: true description: Save the information in `venue` as a new contact of the current terminal or customer (based on `counterparty_guid`) venue: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/pickup/properties/venue" delivery: type: object properties: scheduled_at: type: string format: date-time nullable: true example: "2019-11-20T10:33:29.112+0000" scheduled_ends_at: type: string format: date-time nullable: true example: "2019-11-22T10:33:29.112+0000" scheduled_at_by_customer: type: string format: date-time nullable: true example: "2019-11-20T10:33:29.112+0000" scheduled_ends_at_by_customer: type: string format: date-time nullable: true example: "2019-11-20T10:33:29.112+0000" scheduled_at_by_carrier: type: string format: date-time nullable: true readOnly: true example: "2019-11-15T10:33:29.112+0000" description: The updated date set by the carrier adjusted_date: type: string format: date-time nullable: true example: "2019-11-22T10:33:29.112+0000" notes: type: string nullable: true date_type: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/pickup/properties/date_type" completed_at: type: string format: date-time nullable: true readOnly: true example: null counterparty_guid: type: string format: uuid nullable: true description: "The `guid` of a customer or terminal to reuse their existing information. If `counterparty_guid` is specified and all other information omitted, all terminal information will be automatically filled by the system." example: 4f797316-63a8-432a-a4ef-2986b8occ89d save_as_new: type: boolean default: null nullable: true description: Save the information in `venue` as a terminal save_as_new_contact: type: boolean default: null nullable: true description: Save the information in `venue` as a new contact of the current terminal or customer (based on `counterparty_guid`) venue: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/pickup/properties/venue" customer: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/customer" dispatch_sheet_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../dispatch-sheet.pdf" pdf_bol_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/BOL.pdf" pdf_bol_url_with_template: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/BOL.pdf" pdf_delivery_receipt_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/delivery-receipt.pdf" online_bol_url: type: string format: uri readOnly: true nullable: true example: "https://bol.superdispatch.com/f0446d" vehicles: type: array items: $ref: "#/paths/~1orders~1%7Border_guid%7D~1vehicles/post/requestBody/content/application~1json/schema" distance_meters: type: number format: float readOnly: true distance_duration_seconds: type: number format: int64 readOnly: true transport_type: type: string enum: - OPEN - ENCLOSED - DRIVEAWAY default: OPEN OrderActivityListResponse: description: A list of activities of a specific order content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: objects: type: array items: type: object properties: guid: type: string format: uuid id: type: number format: int64 created_at: type: string format: date-time example: "2019-11-15T10:33:29.112+0000" action_status: type: string enum: - SUCCESS - FAILED - IN_PROGRESS carrier_address: type: string nullable: true example: "Main street, 5" carrier_city: type: string nullable: true example: Salt Lake City carrier_contact_name: type: string nullable: true example: John Smith carrier_email: type: string nullable: true example: example@email.com carrier_guid: type: string format: uuid nullable: true carrier_name: type: string nullable: true carrier_phone: type: string nullable: true example: +1 234 5678 910 carrier_state: type: string nullable: true example: UT carrier_usdot: type: string nullable: true example: 123456 carrier_zip: type: string nullable: true example: 84199 code: type: string enum: - picked_up - created - split - offer_sent - delivered - accepted - updated_to_accepted - declined - canceled - order_canceled - invoiced - customer_invoiced - updated_pickup_delivery_info_by_carrier - manually_marked_as_new - manually_marked_as_pending - manually_marked_as_picked_up - manually_marked_as_delivered - manually_marked_as_accepted - rolled_back_manual_status_change - paid - customer_paid - archived - unarchived - flagged - unflagged - posted_to_loadboard - unposted_from_loadboard - removed_from_loadboard - removed - restored - booked - load_request_created - load_request_approved_by_broker - load_request_approved_by_carrier - load_request_declined_by_broker - load_request_canceled - load_request_updated driver_name: type: string nullable: true driver_phone: type: string nullable: true error_details: type: string nullable: true error_message: type: string nullable: true status: type: string enum: - new - pending - accepted - canceled - declined - picked_up - delivered - invoiced - paid user: type: object properties: guid: type: string format: uuid nullable: true is_active: type: boolean default: true is_superuser: type: boolean default: false created_at: type: string format: date-time nullable: true example: "2019-11-15T10:33:29.112+0000" changed_at: type: string format: date-time nullable: true example: "2019-11-15T10:33:29.112+0000" email: type: string format: email nullable: true first_name: type: string nullable: true last_name: type: string nullable: true username: type: string nullable: true vehicles: type: array items: properties: guid: type: string format: uuid nullable: false status: type: string example: picked_up nullable: false lot_number: type: string maxLength: 100 nullable: true example: 1234 make: type: string maxLength: 50 nullable: true example: BMW model: type: string maxLength: 100 nullable: true example: Gran Coupe vin: type: string maxLength: 50 nullable: true example: 1G8AL52F03Z157046 year: type: number format: int32 nullable: true example: 2012 pagination: $ref: "#/components/responses/WebhooksResponse/content/application~1json/schema/allOf/1/properties/data/properties/pagination" BOLResponse: description: BOL details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: type: object properties: url: type: string format: uri description: A BOL URL example: "https://superdispatch.com/orders/pdf-bol/7d7733322dd?template=default" OrderListWithShortDetailsResponse: description: A list of orders with short details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: objects: type: array items: type: object properties: number: type: string description: The order number that is used for invoicing or dispatching example: ORDER-4532 guid: type: string format: uuid created_at: type: string format: date-time readOnly: true example: "2019-11-15T10:33:29.112+0000" pagination: $ref: "#/components/responses/WebhooksResponse/content/application~1json/schema/allOf/1/properties/data/properties/pagination" OrderPostedToCDResponse: description: Order details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/0" - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - $ref: "#/components/responses/CanceledOrderResponse/content/application~1json/schema/allOf/1/properties/data/properties/object/allOf/2" - type: object required: - number properties: number: type: string description: The order number that is used for invoicing or dispatching example: ORDER-4532 inspection_type: type: string enum: - standard - advanced - aiag description: "Different types of inspection. `standard` is a default inspection process that drivers perform on the mobile app. `advanced` requires the driver to add at least 6 photos, and have location information and geotagging enabled on their mobile app. `aiag` requires the driver to mark damages with AIAG Inspection Standard codes and take 2 photos. Read more: https://support.superdispatch.com/hc/en-us/articles/37239414473619-Inspection-Type-Options" status: type: string enum: - new - pending - accepted - canceled - declined - picked_up - delivered - invoiced - paid - order_canceled description: The order status is_status_changed_manually: type: boolean readOnly: true default: false dispatcher_name: type: string nullable: true example: Sherry Turner dispatcher: $ref: "#/components/responses/CanceledOrderResponse/content/application~1json/schema/allOf/1/properties/data/properties/object/allOf/3/properties/dispatcher" sales_representative: type: string nullable: true example: Alma Dubois price: type: number format: float nullable: true example: 325 price_per_km: type: number format: float nullable: true readOnly: true example: 2 is_posted_to_loadboard: type: boolean readOnly: true default: false posted_to_loadboard_at: type: string format: date-time nullable: true readOnly: true example: "2019-11-15T10:33:29.112+0000" is_flagged: type: boolean readOnly: true default: false is_on_hold: type: boolean readOnly: true default: false broker_fee: type: number format: float nullable: true example: 50 instructions: type: string nullable: true loadboard_instructions: type: string nullable: true payment: $ref: "#/paths/~1orders~1%7Bguid%7D~1mark_as_paid/put/requestBody/content/application~1json/schema" customer_payment: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/customer_payment" pickup: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/pickup" delivery: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/delivery" customer: $ref: "#/components/responses/CanceledOrderResponse/content/application~1json/schema/allOf/1/properties/data/properties/object/allOf/3/properties/customer" dispatch_sheet_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../dispatch-sheet.pdf" pdf_bol_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/BOL.pdf" pdf_bol_url_with_template: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/BOL.pdf" pdf_delivery_receipt_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/delivery-receipt.pdf" online_bol_url: type: string format: uri readOnly: true nullable: true example: "https://bol.superdispatch.com/f0446d" vehicles: type: array items: $ref: "#/paths/~1orders~1%7Border_guid%7D~1vehicles/post/requestBody/content/application~1json/schema" distance_meters: type: number format: float readOnly: true distance_duration_seconds: type: number format: int64 readOnly: true transport_type: type: string enum: - OPEN - ENCLOSED - DRIVEAWAY default: OPEN CanceledOrderResponse: description: Order details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/0" - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - type: object properties: is_archived: type: boolean default: false - type: object required: - number properties: number: type: string description: The order number that is used for invoicing or dispatching example: ORDER-4532 inspection_type: type: string enum: - standard - advanced - aiag description: "Different types of inspection. `standard` is a default inspection process that drivers perform on the mobile app. `advanced` requires the driver to add at least 6 photos, and have location information and geotagging enabled on their mobile app. `aiag` requires the driver to mark damages with AIAG Inspection Standard codes and take 2 photos. Read more: https://support.superdispatch.com/hc/en-us/articles/37239414473619-Inspection-Type-Options" status: type: string enum: - order_canceled - new - pending - accepted - declined - picked_up - delivered - invoiced - paid description: The order status is_status_changed_manually: type: boolean readOnly: true default: false dispatcher_name: type: string nullable: true example: Sherry Turner dispatcher: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/0" - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - type: object properties: username: type: string maxLength: 50 nullable: true example: ZH058gvXGpyHwHQFbxLH email: type: number format: email nullable: true default: null example: johndoe@mail.com first_name: type: string nullable: true example: John last_name: type: string nullable: true example: Doe sales_representative: type: string nullable: true example: Alma Dubois price: type: number format: float nullable: true example: 325 price_per_km: type: number format: float nullable: true readOnly: true example: 2 is_posted_to_loadboard: type: boolean readOnly: true default: false posted_to_loadboard_at: type: string format: date-time nullable: true readOnly: true example: "2019-11-15T10:33:29.112+0000" is_flagged: type: boolean readOnly: true default: false is_on_hold: type: boolean readOnly: true default: false broker_fee: type: number format: float nullable: true example: 50 instructions: type: string nullable: true loadboard_instructions: type: string nullable: true payment: $ref: "#/paths/~1orders~1%7Bguid%7D~1mark_as_paid/put/requestBody/content/application~1json/schema" customer_payment: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/customer_payment" pickup: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/pickup" delivery: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/delivery" customer: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/2" - type: object properties: name: type: string example: First Rate Choice nullable: true contact_name: type: string nullable: true example: Karen Rodriguez phone: type: string nullable: true example: 202-555-0173 email: type: string format: email nullable: true dispatch_sheet_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../dispatch-sheet.pdf" pdf_bol_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/BOL.pdf" pdf_bol_url_with_template: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/BOL.pdf" pdf_delivery_receipt_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/delivery-receipt.pdf" online_bol_url: type: string format: uri readOnly: true nullable: true example: "https://bol.superdispatch.com/f0446d" vehicles: type: array items: $ref: "#/paths/~1orders~1%7Border_guid%7D~1vehicles/post/requestBody/content/application~1json/schema" distance_meters: type: number format: float readOnly: true distance_duration_seconds: type: number format: int64 readOnly: true transport_type: type: string enum: - OPEN - ENCLOSED - DRIVEAWAY default: OPEN LoadRequestAcceptedResponse: description: Order details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/0" - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - $ref: "#/components/responses/CanceledOrderResponse/content/application~1json/schema/allOf/1/properties/data/properties/object/allOf/2" - type: object required: - number properties: number: type: string description: The order number that is used for invoicing or dispatching example: ORDER-4532 inspection_type: type: string enum: - standard - advanced - aiag description: "Different types of inspection. `standard` is a default inspection process that drivers perform on the mobile app. `advanced` requires the driver to add at least 6 photos, and have location information and geotagging enabled on their mobile app. `aiag` requires the driver to mark damages with AIAG Inspection Standard codes and take 2 photos. Read more: https://support.superdispatch.com/hc/en-us/articles/37239414473619-Inspection-Type-Options" status: type: string enum: - new - pending - accepted - canceled - order_canceled - declined - picked_up - delivered - invoiced - paid description: The order status is_status_changed_manually: type: boolean readOnly: true default: false purchase_order_number: type: string default: null nullable: true example: PO 0006 dispatcher_name: type: string nullable: true example: Sherry Turner dispatcher: $ref: "#/components/responses/CanceledOrderResponse/content/application~1json/schema/allOf/1/properties/data/properties/object/allOf/3/properties/dispatcher" sales_representative: type: string nullable: true example: Alma Dubois price: type: number format: float nullable: true example: 325 price_per_km: type: number format: float nullable: true readOnly: true example: 2 is_posted_to_loadboard: type: boolean readOnly: false default: false posted_to_loadboard_at: type: string format: date-time nullable: true readOnly: true example: "2019-11-15T10:33:29.112+0000" is_flagged: type: boolean readOnly: true default: false is_on_hold: type: boolean readOnly: true default: false broker_fee: type: number format: float nullable: true example: 50 instructions: type: string nullable: true loadboard_instructions: type: string nullable: true payment: $ref: "#/paths/~1orders~1%7Bguid%7D~1mark_as_paid/put/requestBody/content/application~1json/schema" customer_payment: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/customer_payment" pickup: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/pickup" delivery: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/delivery" customer: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/customer" dispatch_sheet_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../dispatch-sheet.pdf" pdf_bol_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/BOL.pdf" pdf_bol_url_with_template: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/BOL.pdf" pdf_delivery_receipt_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/delivery-receipt.pdf" online_bol_url: type: string format: uri readOnly: true nullable: true example: "https://bol.superdispatch.com/f0446d" vehicles: type: array items: $ref: "#/paths/~1orders~1%7Border_guid%7D~1vehicles/post/requestBody/content/application~1json/schema" distance_meters: type: number format: float readOnly: true distance_duration_seconds: type: number format: int64 readOnly: true transport_type: type: string enum: - OPEN - ENCLOSED - DRIVEAWAY default: OPEN LoadRequestDeclinedResponse: description: Order details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/0" - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - $ref: "#/components/responses/CanceledOrderResponse/content/application~1json/schema/allOf/1/properties/data/properties/object/allOf/2" - type: object required: - number properties: number: type: string description: The order number that is used for invoicing or dispatching example: ORDER-4532 inspection_type: type: string enum: - standard - advanced - aiag description: "Different types of inspection. `standard` is a default inspection process that drivers perform on the mobile app. `advanced` requires the driver to add at least 6 photos, and have location information and geotagging enabled on their mobile app. `aiag` requires the driver to mark damages with AIAG Inspection Standard codes and take 2 photos. Read more: https://support.superdispatch.com/hc/en-us/articles/37239414473619-Inspection-Type-Options" status: type: string enum: - new - pending - accepted - canceled - declined - picked_up - delivered - invoiced - paid description: The order status is_status_changed_manually: type: boolean readOnly: true default: false purchase_order_number: type: string default: null nullable: true example: PO 0006 dispatcher_name: type: string nullable: true example: Sherry Turner dispatcher: $ref: "#/components/responses/CanceledOrderResponse/content/application~1json/schema/allOf/1/properties/data/properties/object/allOf/3/properties/dispatcher" sales_representative: type: string nullable: true example: Alma Dubois price: type: number format: float nullable: true example: 325 price_per_km: type: number format: float nullable: true readOnly: true example: 2 is_posted_to_loadboard: type: boolean readOnly: false default: true posted_to_loadboard_at: type: string format: date-time nullable: true readOnly: true example: "2019-11-15T10:33:29.112+0000" is_flagged: type: boolean readOnly: true default: false is_on_hold: type: boolean readOnly: true default: false broker_fee: type: number format: float nullable: true example: 50 instructions: type: string nullable: true loadboard_instructions: type: string nullable: true payment: $ref: "#/paths/~1orders~1%7Bguid%7D~1mark_as_paid/put/requestBody/content/application~1json/schema" customer_payment: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/customer_payment" pickup: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/pickup" delivery: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/delivery" customer: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/customer" dispatch_sheet_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../dispatch-sheet.pdf" pdf_bol_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/BOL.pdf" pdf_bol_url_with_template: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/BOL.pdf" pdf_delivery_receipt_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/delivery-receipt.pdf" online_bol_url: type: string format: uri readOnly: true nullable: true example: "https://bol.superdispatch.com/f0446d" vehicles: type: array items: $ref: "#/paths/~1orders~1%7Border_guid%7D~1vehicles/post/requestBody/content/application~1json/schema" distance_meters: type: number format: float readOnly: true distance_duration_seconds: type: number format: int64 readOnly: true transport_type: type: string enum: - OPEN - ENCLOSED - DRIVEAWAY default: OPEN VehicleDetailsResponse: description: Vehicle details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: $ref: "#/paths/~1orders~1%7Border_guid%7D~1vehicles/post/requestBody/content/application~1json/schema" VehicleSamplePhotoResponse: description: Vehicle sample photo content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/0" - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - type: object properties: guid: type: string example: 9ed31c60-a3fb-41dc-9a6b-7aee64bfc456 photo_type: type: string enum: - Sample example: Sample photo_url: type: string format: uri nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/photo1.jpeg" AIAGInspectionDetailsResponse: description: AIAG Inspection details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: allOf: - type: object properties: step: type: string enum: - pickup - delivery example: pickup guid: type: string format: uuid readOnly: true example: eu2818b8-a55e-436a-a61e-993ae0470928 vehicle_guid: type: string format: uuid readOnly: true example: eu2818b8-a55e-436a-djen-993ae0470923 damages: type: array items: allOf: - type: object properties: area: type: string maxLength: 2 nullable: false example: "01" type: type: string maxLength: 2 nullable: false example: "02" severity: type: string maxLength: 2 nullable: false example: "7" guid: type: string format: uuid readOnly: true example: eu281196-a55e-436a-a61e-993ae0440928 marked_at: type: string format: date-time example: "2019-11-15T10:33:29.112+0000" photos: type: array items: allOf: - type: object properties: guid: type: string format: uuid readOnly: true example: eu281196-a55e-436a-a61e-993ae0440928 original_url: type: string nullable: false example: "https://storage.googleapis.com/carrier-tms/media/carriers/eu281196-a55e-436a-a61e-993ae0440928/2021/4/20/example.jpg" taken_at: type: string format: date-time example: "2019-11-15T10:33:29.112+0000" AttachmentDetailsResponse: description: Attachment details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/0" - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - type: object properties: guid: type: string format: uuid readOnly: true example: ef2818b8-a55e-436a-a61e-993ae0470928 name: type: string readOnly: true example: filename.jpeg url: type: string format: uri readOnly: true example: "https://www.googleapis.com/.../filename.jpeg" content_type: type: string readOnly: true example: image/jpeg is_private: type: boolean default: false readOnly: true description: The attachment is internal and available only on Shipper TMS. is_read_only: type: boolean default: false readOnly: true description: The attachment cannot be changed or deleted by a carrier on Carrier TMS. is_location_protected: type: boolean default: false readOnly: true description: When true, the GPS location metadata embedded in the uploaded photo is protected and not exposed. AttachmentListResponse: description: A list of attachments content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: objects: type: array items: $ref: "#/components/responses/AttachmentDetailsResponse/content/application~1json/schema/allOf/1/properties/data/properties/object" pagination: $ref: "#/components/responses/WebhooksResponse/content/application~1json/schema/allOf/1/properties/data/properties/pagination" CommentDetailsResponse: description: Comment details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: $ref: "#/paths/~1orders~1%7Border_guid%7D~1comments~1%7Bguid%7D/put/requestBody/content/application~1json/schema" CommentListDetailsResponse: description: A list of order comments content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: objects: type: array items: $ref: "#/paths/~1orders~1%7Border_guid%7D~1comments~1%7Bguid%7D/put/requestBody/content/application~1json/schema" pagination: $ref: "#/components/responses/WebhooksResponse/content/application~1json/schema/allOf/1/properties/data/properties/pagination" OfferDetailsResponse: description: Offer details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/0" - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - type: object properties: status: type: string enum: - pending - accepted - picked_up - declined - canceled - delivered - invoiced - paid readOnly: true description: The offer and order status. To make tracking easier the order statuses are also available here. is_status_changed_manually: type: boolean default: false readOnly: true description: This is `true` when the order status is changed manually on Shipper TMS. carrier_guid: type: string format: uuid description: The carrier GUID is used to find a carrier or retrieve the carrier details. REQUIRED if carrier's GUID is known. carrier_usdot: type: string example: 12345 description: The carrier USDOT number is used to find a carrier to send a load offer. REQUIRED if carrier's GUID is unknown. carrier_email: type: string format: email description: The carrier email is used to create an offer for a carrier that is not yet registered in Super Dispatch. nullable: true carrier_phone: type: string format: phone example: 18123456789 description: The carrier phone is used to create an offer for a carrier that is not yet registered in Super Dispatch. nullable: true carrier_name: type: string nullable: true readOnly: true carrier_contact_name: type: string nullable: true readOnly: true carrier_address: type: string nullable: true readOnly: true carrier_city: type: string nullable: true readOnly: true carrier_state: type: string nullable: true readOnly: true carrier_zip: type: string nullable: true readOnly: true driver_name: type: string nullable: true readOnly: true description: The driver name who is moving the load. Available after assigning the order to a driver. driver_phone: type: string nullable: true readOnly: true description: The driver phone number to contact them directly. OfferListResponse: description: A list of offers content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: objects: type: array items: $ref: "#/components/responses/OfferDetailsResponse/content/application~1json/schema/allOf/1/properties/data/properties/object" pagination: $ref: "#/components/responses/WebhooksResponse/content/application~1json/schema/allOf/1/properties/data/properties/pagination" WebhooksResponse: description: The list of webhooks content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: objects: type: array items: $ref: "#/paths/~1webhooks~1%7Baction%7D~1subscribe/post/requestBody/content/application~1json/schema" pagination: type: object properties: total_pages: type: integer format: int32 description: The number of pages total_objects: type: integer format: int64 description: The total number of objects found limit: type: integer format: int32 default: 20 description: The number of objects per page page: type: integer format: int32 description: The current page index FailedWebhooksResponse: description: The list of failed webhooks content: application/json: schema: allOf: - type: object properties: data: type: object properties: objects: type: array items: allOf: - type: object properties: created_at: type: string format: date-time example: "2019-11-15T10:33:29.112+0000" action: $ref: "#/paths/~1webhooks~1%7Baction%7D/parameters/0/schema" object_guid: type: string format: uuid example: ef2818b8-a55e-436a-a61e-993ae0470928 nullable: false object_type: type: string example: OFFER nullable: false activity_guid: type: string format: uuid example: ef2818b8-a55e-436a-a61e-993ae0470928 nullable: false error_message: nullable: true type: string example: Validation Error pagination: $ref: "#/components/responses/WebhooksResponse/content/application~1json/schema/allOf/1/properties/data/properties/pagination" WebhookResponse: description: Webhook details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: $ref: "#/paths/~1webhooks~1%7Baction%7D~1subscribe/post/requestBody/content/application~1json/schema" WebhookActionListResponse: description: The list of webhook actions content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: objects: type: array enum: - - order.created - order.modified - order.cancel - order.submitted_by_customer - order.picked_up - order.picked_up.ignored - order.delivered - order.delivered.ignored - order.picked_up_bol - order.delivered_bol - order.paid - order.unmark_as_paid - order.customer_paid - order.invoiced - order.customer_invoiced - order.archived - order.marked_as_on_hold - order.unmarked_as_on_hold - order.unarchived - order.posted_to_slb - order.removed_from_slb - order.booked - load_request.declined_by_shipper - load_request.canceled_by_carrier - load_request.created - load_request.updated - order.manually_marked_as_new - order.manually_marked_as_pending - order.manually_marked_as_picked_up - order.manually_marked_as_delivered - order.manually_marked_as_accepted - order.manually_marked_as_invoiced - order.manually_unmarked_as_invoiced - order.rolled_back_manual_status_change - order.removed - order.restored - offer.sent - offer.sent.failed - offer.accepted - offer.accepted.ignored - offer.updated_to_accepted - offer.updated_to_accepted.ignored - offer.declined - offer.declined.ignored - offer.canceled - vehicle.created - vehicle.modified - vehicle.deleted - vehicle.pickup_eta_updated_by_driver - vehicle.delivery_eta_updated_by_driver - vehicle.gps_activated - vehicle.gps_deactivated readOnly: true pagination: $ref: "#/components/responses/WebhooksResponse/content/application~1json/schema/allOf/1/properties/data/properties/pagination" tags: - name: Authentication description: Authentication - name: Carriers description: Manage carriers - name: Customers description: Manage customers and contacts - name: Terminals description: Manage terminals and contacts - name: Orders description: Manage orders - name: Loads description: Manage loads - name: Vehicles description: Manage order vehicles - name: Attachments description: Manage order attachments - name: Comments description: Manage order comments - name: Offers description: "List, send, and cancel load offers" - name: Shipper-to-Broker flow description: "Get linked brokers’ list, submit a new order to a linked broker" - name: Loadboard integration description: "Post to Super Loadboard. See [Loadboard integration](/docs/shipper/loadboards) for more details" - name: Webhooks description: Manage webhooks - name: Tags description: Manage order tags - name: Price negotiation description: Manage price negotiations for orders - name: Integrated insurance description: "Quote premium price and manage Shipper's Interest insurance on orders" security: - oauth2: [] paths: /oauth/token: servers: - url: "https://api.shipper.superdispatch.com" description: The Production (live) server post: summary: Authenticate an API client tags: - Authentication parameters: - name: grant_type in: query required: true schema: type: string default: client_credentials security: - basicAuth: [] responses: "200": $ref: "#/components/responses/AuthenticationSuccessResponse" "400": $ref: "#/components/responses/AuthenticationValidationErrorResponse" "401": $ref: "#/components/responses/AuthenticationFailedResponse" /carriers/full_search: parameters: - $ref: "#/components/parameters/carrier_usdot" - $ref: "#/components/parameters/carrier_mcNumber" - $ref: "#/components/parameters/carrier_name" - $ref: "#/components/parameters/carrier_email" - $ref: "#/components/parameters/carrier_phone" get: summary: Search carriers in Super Dispatch Carrier Database tags: - Carriers responses: "200": $ref: "#/components/responses/CarrierListWithDetailsResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" /carriers/full_search_with_fmcsa: parameters: - $ref: "#/components/parameters/carrier_usdot" - $ref: "#/components/parameters/carrier_mcNumber" - $ref: "#/components/parameters/carrier_name" - $ref: "#/components/parameters/carrier_email" - $ref: "#/components/parameters/carrier_phone" get: summary: Search carriers in Super Dispatch Carrier Database and the FMCSA database description: "This endpoint looks for carriers that matches one of the query parameters in the Super Dispatch Carrier Database. If the carrier wasn't found then it searches carriers in the FMCSA database. If the carrier is found in the FMCSA database, the `guid`, `broker_records`, `cargo_policy` fields will be `null`." tags: - Carriers responses: "200": $ref: "#/components/responses/CarrierFromFMCSAListWithDetailsResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" /carriers/approved: parameters: - $ref: "#/paths/~1webhooks/parameters/0" - $ref: "#/paths/~1webhooks/parameters/1" get: summary: List of approved carriers tags: - Carriers responses: "200": $ref: "#/components/responses/ApprovedCarrierListWithDetailsResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" /carriers/insurance_certificate_holder: parameters: - $ref: "#/paths/~1webhooks/parameters/0" - $ref: "#/paths/~1webhooks/parameters/1" get: summary: List of carriers that hold insurance certificate tags: - Carriers responses: "200": $ref: "#/components/responses/CertHolderCarrierListWithDetailsResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" /carriers/blacklisted: parameters: - $ref: "#/paths/~1webhooks/parameters/0" - $ref: "#/paths/~1webhooks/parameters/1" get: summary: List of blacklisted carriers tags: - Carriers responses: "200": $ref: "#/components/responses/BlacklistedCarrierListWithDetailsResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" /carriers/preferred: parameters: - $ref: "#/paths/~1webhooks/parameters/0" - $ref: "#/paths/~1webhooks/parameters/1" get: summary: List of preferred carriers tags: - Carriers responses: "200": $ref: "#/components/responses/PreferredCarrierListWithDetailsResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" /carriers/internal: get: summary: List of internal carriers tags: - Carriers parameters: - $ref: "#/components/parameters/carrier_query" - $ref: "#/paths/~1webhooks/parameters/0" - $ref: "#/paths/~1webhooks/parameters/1" responses: "200": $ref: "#/components/responses/CarrierListWithDetailsResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" post: summary: Create a new internal carrier tags: - Carriers requestBody: content: application/json: schema: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - $ref: "#/paths/~1terminals/post/requestBody/content/application~1json/schema/allOf/1" - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/2" - type: object properties: carrier_type: type: string enum: - CTMS - INTERNAL - FMCSA readOnly: true description: "The carrier type: `CTMS` is a real carrier that uses Carrier TMS, `INTERNAL` is a carrier managed only on Shipper TMS, `FMCSA` is a carrier that exists in the FMCSA database" broker_records: $ref: "#/paths/~1carriers~1%7Bguid%7D~1profile/put/requestBody/content/application~1json/schema" description: Custom records saved for this specific carrier. This information is not available for carriers on Carrier TMS. responses: "201": $ref: "#/components/responses/CarrierWithDetailsResponse" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "/carriers/internal/{guid}": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" put: summary: Update internal carrier details tags: - Carriers requestBody: content: application/json: schema: $ref: "#/paths/~1carriers~1internal/post/requestBody/content/application~1json/schema" responses: "200": $ref: "#/components/responses/CarrierWithDetailsResponse" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" delete: summary: Delete an internal carrier tags: - Carriers responses: "204": description: The carrier is deleted "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/carriers/{guid}": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" get: summary: Get carrier details from Super Dispatch Carrier Database description: | This endpoint only returns the carrier details if the carrier guid exists in Super Dispatch Carrier Database. Internal carriers that are manually created on Shipper TMS (or via API) cannot be returned by this endpoint. Use another endpoint to get an internal carrier by `guid`. A new carrier is created automatically when a load offer is sent to the carrier. tags: - Carriers responses: "200": $ref: "#/components/responses/CarrierDetailsResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/carriers/custom_external_id/{custom_external_id}": parameters: - name: custom_external_id description: A custom external ID in: path required: true schema: type: string get: summary: Get carrier details by using a custom external ID tags: - Carriers responses: "200": $ref: "#/components/responses/CarrierDetailsResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/carriers/{guid}/profile": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" get: summary: Get carrier profile tags: - Carriers responses: "200": $ref: "#/paths/~1carriers~1private-network/get/responses/200" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" put: summary: Update carrier profile tags: - Carriers requestBody: content: application/json: schema: type: object readOnly: true properties: guid: type: string format: uuid readOnly: true example: 4f797316-63a8-432a-a4ef-2986b8occ89d usdot_number: type: string nullable: true readOnly: true example: "03324" approved: type: boolean default: false description: "Approved carrier status helps shippers differentiate carriers who they have verified, onboarded, and/or have done business with. A carrier cannot be Approved and Blacklisted at the same time." approved_since: type: string format: date-time readOnly: true nullable: true default: null example: "2019-11-15T10:33:29.112+0000" preferred: type: boolean default: false description: Preferred status allows the carrier to instantly book loads posted by the shipper in the Super Loadboard. Carrier will automatically become approved once it's marked as preferred. preferred_since: type: string format: date-time readOnly: true nullable: true default: null example: "2019-11-15T10:33:29.112+0000" in_blacklist: type: boolean default: false description: It indicates an issue with the carrier and does not allow the carrier to book or request any loads inside the Super Loadboard. A carrier cannot be Approved and Blacklisted at the same time. in_blacklist_since: type: string format: date-time readOnly: true nullable: true default: null example: "2019-11-15T10:33:29.112+0000" insurance_certificate_holder: type: boolean default: false description: Marks the carrier as a Certificate Holder. insurance_certificate_holder_since: type: string format: date-time readOnly: true nullable: true default: null insurance_cert_holder_file_url: type: string format: uri readOnly: true nullable: true default: null example: "https://superdispatch-attachments.s3.amazonaws.com/files/carriers/ea0f383a5a7146e48f2136dd3ee38f83/insurance-cert-holder.pdf" insurance_expires_at: type: string format: date nullable: true default: null custom_external_id: type: string nullable: true default: null example: CARRIER-0099 is_in_private_network: type: boolean default: false description: Add carrier to the private network private_network_groups: type: array description: Private network groups of the carrier items: type: object description: Private network group of the carrier properties: name: type: string description: Unique name of the group example: Can move EVs guid: type: string format: uuid description: Unique GUID of the group responses: "200": $ref: "#/paths/~1carriers~1private-network/get/responses/200" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/carriers/{guid}/profile/mark_as_approved": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" put: summary: Mark carrier as approved description: | Note: `Carrier cannot be approved and blacklisted at the same time` tags: - Carriers responses: "204": description: Carrier profile updated "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "409": $ref: "#/paths/~1loadboard~1orders~1%7Bguid%7D~1private-network/post/responses/409" "/carriers/{guid}/profile/unmark_as_approved": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" put: summary: Unmark carrier as approved description: | Note: `Removing Approved flag will also remove Preferred flag of the carrier` tags: - Carriers responses: "204": description: Carrier profile updated "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/carriers/{guid}/profile/mark_as_preferred": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" put: summary: Mark carrier as preferred description: | Note: `Carrier will automatically become approved once it's marked as preferred` tags: - Carriers responses: "204": description: Carrier profile updated "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "409": $ref: "#/paths/~1loadboard~1orders~1%7Bguid%7D~1private-network/post/responses/409" "/carriers/{guid}/profile/unmark_as_preferred": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" put: summary: Unmark carrier as preferred description: | Note: `Removing Preferred flag will not remove carrier's approved status` tags: - Carriers responses: "204": description: Carrier profile updated "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/carriers/{guid}/profile/mark_as_certificate_holder": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" put: summary: Mark carrier as certificate holder tags: - Carriers responses: "204": description: Carrier profile updated "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/carriers/{guid}/profile/unmark_as_certificate_holder": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" put: summary: Unmark carrier as certificate holder tags: - Carriers responses: "204": description: Carrier profile updated "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/carriers/{guid}/profile/mark_as_blacklisted": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" put: summary: Mark carrier as blacklisted description: | Note: `Carrier cannot be approved and blacklisted at the same time` tags: - Carriers responses: "204": description: Carrier profile updated "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "409": $ref: "#/paths/~1loadboard~1orders~1%7Bguid%7D~1private-network/post/responses/409" "/carriers/{guid}/profile/unmark_as_blacklisted": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" put: summary: Unmark carrier as blacklisted tags: - Carriers responses: "204": description: Carrier profile updated "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/carriers/{guid}/notes": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" post: summary: Add shipper's notes to carrier profile tags: - Carriers requestBody: content: application/json: schema: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/0" - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - type: object properties: note: type: string example: Should be checked next time. responses: "200": $ref: "#/components/responses/CarrierNoteResponse" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/carriers/{guid}/insurance_holder_cert_file": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" post: summary: Upload insurance certificate holder file tags: - Carriers requestBody: content: multipart/form-data: schema: type: object properties: file: type: string format: binary responses: "200": description: The uploaded file URL content: text/plain: schema: type: string format: uri example: "https://storage.googleapis.com/broker-files/carrier-profile/f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/insurance-certificate-holder.pdf" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/carriers/{guid}/payment-methods/ach": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" get: summary: Get carrier ACH payment details description: | Returns the carrier's ACH payment information. ACH data will be masked unless there was a delivered order with ACH, Direct Deposit, or Other payment method within the last 30 days. tags: - Carriers responses: "200": description: Carrier ACH payment details content: application/json: schema: allOf: - $ref: "#/paths/~1orders/get/responses/200/content/application~1json/schema/allOf/0" - type: object properties: data: type: object properties: object: type: object properties: bank_name: type: string nullable: true readOnly: true description: Name of the bank example: "Chase Bank" bank_routing_number: type: string nullable: true readOnly: true description: "Bank routing number. May be masked as `***XXX`" example: "***021" bank_account_number: type: string nullable: true readOnly: true description: "Bank account number. May be masked as `***XXXX`" example: "***6789" voided_check_url: type: string format: uri nullable: true readOnly: true description: URL to the voided check image example: "https://superdispatch-attachments.s3.amazonaws.com/files/carriers/ea0f383a5a7146e48f2136dd3ee38f83/voided-check.jpeg" voided_check_url_available: type: boolean readOnly: true description: Whether a voided check URL exists example: true ach_last_update_date: type: string format: date nullable: true readOnly: true description: Date of the last ACH information update example: "2026-03-15" access_expires_in_days: type: integer readOnly: true description: "Number of days until access expires. Returns `-1` if not applicable" example: 25 "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" /customers: get: summary: Get customers tags: - Customers parameters: - $ref: "#/paths/~1webhooks/parameters/0" - $ref: "#/paths/~1webhooks/parameters/1" - name: sort description: The fields that should be sorted by in: query schema: type: array items: type: string example: - "name,asc" explode: true responses: "200": description: The list of customers $ref: "#/components/responses/CustomerListResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": description: The requested object does not exist content: application/json: schema: $ref: "#/components/responses/ErrorResponse/content/application~1json/schema" post: summary: Create a new customer tags: - Customers requestBody: content: application/json: schema: allOf: - type: object properties: is_active: type: boolean default: true readOnly: true - type: object properties: created_at: type: string format: date-time readOnly: true example: "2019-11-15T10:33:29.112+0000" changed_at: type: string format: date-time readOnly: true example: "2019-11-15T10:33:29.112+0000" guid: type: string format: uuid readOnly: true example: 4f797316-63a8-432a-a4ef-2986b8occ89d - type: object properties: address: type: string nullable: true example: 8 Philmont Dr. city: type: string nullable: true example: Memphis state: type: string nullable: true example: TN zip: type: string nullable: true example: 38106 - type: object required: - name properties: name: type: string example: First Rate Choice business_type: type: string enum: - DEALER - PRIVATE - AUCTION - REPO_YARD - PORT - BUSINESS nullable: true email: type: string format: email phone: type: string nullable: true example: 202-555-0173 fax: type: string nullable: true example: 202-555-0174 custom_external_id: type: string description: A custom ID that can be used by an API client to keep a connection between two systems nullable: true example: ID-0564 notes: type: string nullable: true example: "Still waiting on further instruction from client on how they want to proceed with this unit. CONDITION: All 4 wheels where dry rotted, 1 tire was in very bad shape." internal_notes: type: string nullable: true loadboard_instructions: type: string description: These instructions are shown on Super Loadboard nullable: true example: Next day pay available order_instructions: type: string description: Instructions for a carrier nullable: true example: "Transporter must inspect the car and must record on the gate pass any damages, any dent, any scratches, ETC. Transporter must take a pictures of any damages, any dent, any scratches prior to picking up the car. Please use extra time." personal_page_url: type: string format: uri nullable: true responses: "201": $ref: "#/components/responses/CustomerDetailsResponse" description: The contact is created "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "/customers/custom_external_id/{custom_external_id}": get: summary: Get customers by Custom External ID tags: - Customers parameters: - $ref: "#/components/parameters/custom_external_id" - $ref: "#/paths/~1webhooks/parameters/0" - $ref: "#/paths/~1webhooks/parameters/1" - $ref: "#/paths/~1customers/get/parameters/2" responses: "200": description: A list of customers $ref: "#/components/responses/CustomerListResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/customers/{guid}": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" get: summary: Get customer details tags: - Customers responses: "200": $ref: "#/components/responses/CustomerDetailsResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" put: summary: Update customer details tags: - Customers requestBody: content: application/json: schema: $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema" responses: "200": $ref: "#/components/responses/CustomerDetailsResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/customers/{customer_guid}/contacts": get: summary: Get customer contacts tags: - Customers parameters: - $ref: "#/components/parameters/customer_guid" - $ref: "#/paths/~1webhooks/parameters/0" - $ref: "#/paths/~1webhooks/parameters/1" - $ref: "#/paths/~1customers/get/parameters/2" responses: "200": description: The list of customers $ref: "#/components/responses/ContactListResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" post: summary: Create a new customer contact tags: - Customers requestBody: content: application/json: schema: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/0" - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - type: object required: - name properties: name: type: string example: First Rate Choice title: type: string nullable: true example: Billing phone: type: string nullable: true example: 202-555-0173 mobile_phone: type: string nullable: true example: 202-555-0174 email: type: string format: email nullable: true is_primary: type: boolean default: false responses: "201": $ref: "#/components/responses/ContactDetailsResponse" description: The contact is created "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "/customers/{customer_guid}/contacts/{guid}": parameters: - $ref: "#/components/parameters/customer_guid" - $ref: "#/paths/~1orders~1guid/parameters/0" put: summary: Update customer contact details tags: - Customers requestBody: content: application/json: schema: $ref: "#/paths/~1customers~1%7Bcustomer_guid%7D~1contacts/post/requestBody/content/application~1json/schema" responses: "200": $ref: "#/components/responses/ContactDetailsResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/customers/{customer_guid}/contacts/{guid}/mark_as_primary": parameters: - $ref: "#/components/parameters/customer_guid" - $ref: "#/paths/~1orders~1guid/parameters/0" put: summary: Mark a customer contact as primary tags: - Customers responses: "200": description: Marked as primary "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" /terminals: get: summary: Get terminals tags: - Terminals parameters: - $ref: "#/paths/~1webhooks/parameters/0" - $ref: "#/paths/~1webhooks/parameters/1" - $ref: "#/paths/~1customers/get/parameters/2" responses: "200": description: The list of terminals $ref: "#/components/responses/TerminalListResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" post: summary: Create a new terminal tags: - Terminals requestBody: content: application/json: schema: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - type: object required: - name properties: name: type: string example: First Rate Choice email: type: string format: email nullable: true dba_name: type: string nullable: true example: FIRST RATE CHOICE phone_numbers: type: string nullable: true example: 202-555-0173 fax: type: string nullable: true example: 573-291-1978 website: type: string nullable: true format: hostname contact_name: type: string nullable: true example: Karen Rodriguez w9: type: string format: uri readOnly: true nullable: true example: "https://superdispatch-attachments.s3.amazonaws.com/files/carriers/ea0f383a5a7146e48f2136dd3ee38f83/w9.jpeg" usdot_certificate: type: string format: uri readOnly: true nullable: true example: "https://superdispatch-attachments.s3.amazonaws.com/files/carriers/ea0f383a5a7146e48f2136dd3ee38f83/usdot-certificate.jpeg" cargo_insurance: type: string format: uri readOnly: true nullable: true example: "https://superdispatch-attachments.s3.amazonaws.com/files/carriers/ea0f383a5a7146e48f2136dd3ee38f83/cargo-insurance.pdf" us_dot: type: string readOnly: true nullable: true cargo_policy: readOnly: true nullable: true type: object properties: policy_expiration_date: type: string format: date limit: type: number format: float example: 0.2 deductible: type: number format: float example: 22 agent_name: type: string example: Angie Helman agent_phone: type: string example: 860-569-5538 country: type: string readOnly: true nullable: true example: US mc_number: type: string readOnly: true nullable: true example: MC-123456 company_type: type: string readOnly: true nullable: true example: fleet number_of_trucks: type: number readOnly: true nullable: true example: 1 is_super: type: boolean default: false description: "`true` if the carrier is marked as Super Carrier (e.g. the carrier has provided required documents and they are verified)" terms_and_conditions: type: string readOnly: true nullable: true example: Example of terms and conditions logo: type: string format: uri readOnly: true nullable: true example: "https://superdispatch-attachments.s3.amazonaws.com/files/carriers/ea0f383a5a7146e48f2136dd3ee38f83/logo.jpeg" has_signed_up: type: boolean default: false billing_contact_name: type: string readOnly: true nullable: true billing_email: type: string readOnly: true nullable: true billing_phone_numbers: type: string readOnly: true nullable: true in_business_since: type: number readOnly: true nullable: true joined_since: type: date-time readOnly: true nullable: true is_verified: type: boolean default: false description: "`true` if the carrier is marked as Super Carrier (e.g. the carrier has provided required documents and they are verified)" ach_payment: type: object readOnly: true nullable: true deprecated: true description: "**Deprecated.** This field will be removed on July 8, 2026. Use `GET /carriers/{guid}/payment-methods/ach` instead. See [API change: Carrier ACH restriction](https://superdispatch.notion.site/API-change-Carrier-ACH-restriction-32fd135ec9cb809ebe96fad5b4996c11?pvs=74) for details." properties: bank_name: type: string nullable: true readOnly: true deprecated: true description: "**Deprecated.** Will be removed on July 8, 2026." bank_routing_number: type: string nullable: true readOnly: true deprecated: true description: "**Deprecated.** Will be removed on July 8, 2026." bank_account_number: type: string nullable: true readOnly: true deprecated: true description: "**Deprecated.** Will be removed on July 8, 2026." voided_check_url: type: string format: uri nullable: true readOnly: true deprecated: true description: "**Deprecated.** Will be removed on July 8, 2026." example: "https://superdispatch-attachments.s3.amazonaws.com/files/carriers/ea0f383a5a7146e48f2136dd3ee38f83/voided-check.jpeg" - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/2" - type: object required: - name properties: name: type: string example: First Rate Choice custom_external_id: type: string description: A custom ID that can be used by an API client to keep a connection between two systems nullable: true example: ID-0564 responses: "201": $ref: "#/components/responses/TerminalDetailsResponse" description: The terminal is created "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "/terminals/{guid}": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" get: summary: Get terminal details tags: - Terminals responses: "200": $ref: "#/components/responses/TerminalDetailsResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" put: summary: Update terminal details tags: - Terminals requestBody: content: application/json: schema: $ref: "#/paths/~1terminals/post/requestBody/content/application~1json/schema" responses: "200": $ref: "#/components/responses/TerminalDetailsResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/terminals/{terminal_guid}/contacts": get: summary: Get terminal contacts tags: - Terminals parameters: - $ref: "#/components/parameters/terminal_guid" - $ref: "#/paths/~1webhooks/parameters/0" - $ref: "#/paths/~1webhooks/parameters/1" - $ref: "#/paths/~1customers/get/parameters/2" responses: "200": description: The list of terminal contacts $ref: "#/components/responses/ContactListResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" post: summary: Create a new terminal contact tags: - Terminals requestBody: content: application/json: schema: $ref: "#/paths/~1customers~1%7Bcustomer_guid%7D~1contacts/post/requestBody/content/application~1json/schema" responses: "201": $ref: "#/components/responses/ContactDetailsResponse" description: The contact is created "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "/terminals/{terminal_guid}/contacts/{guid}": parameters: - $ref: "#/components/parameters/terminal_guid" - $ref: "#/paths/~1orders~1guid/parameters/0" put: summary: Update terminal contact details tags: - Terminals requestBody: content: application/json: schema: $ref: "#/paths/~1customers~1%7Bcustomer_guid%7D~1contacts/post/requestBody/content/application~1json/schema" responses: "200": $ref: "#/components/responses/ContactDetailsResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/terminals/{terminal_guid}/contacts/{guid}/mark_as_primary": parameters: - $ref: "#/components/parameters/terminal_guid" - $ref: "#/paths/~1orders~1guid/parameters/0" put: summary: Mark a terminal contact as primary tags: - Terminals responses: "200": description: Marked as primary "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" /orders: get: tags: - Orders summary: Find order by offer GUID parameters: - name: offer_guid in: query required: true schema: type: string responses: "200": description: Order details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/0" - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - $ref: "#/components/responses/CanceledOrderResponse/content/application~1json/schema/allOf/1/properties/data/properties/object/allOf/2" - type: object required: - number properties: number: type: string description: The order number that is used for invoicing or dispatching example: ORDER-4532 inspection_type: type: string enum: - standard - advanced - aiag description: "Different types of inspection. `standard` is a default inspection process that drivers perform on the mobile app. `advanced` requires the driver to add at least 6 photos, and have location information and geotagging enabled on their mobile app. `aiag` requires the driver to mark damages with AIAG Inspection Standard codes and take 2 photos. Read more: https://support.superdispatch.com/hc/en-us/articles/37239414473619-Inspection-Type-Options" status: type: string enum: - new - pending - accepted - canceled - declined - picked_up - delivered - invoiced - paid - order_canceled description: The order status is_status_changed_manually: type: boolean readOnly: true default: false purchase_order_number: type: string default: null nullable: true example: PO 0006 dispatcher_name: type: string nullable: true example: Sherry Turner dispatcher: $ref: "#/components/responses/CanceledOrderResponse/content/application~1json/schema/allOf/1/properties/data/properties/object/allOf/3/properties/dispatcher" sales_representative: type: string nullable: true example: Alma Dubois price: type: number format: float nullable: true example: 325 price_per_km: type: number format: float nullable: true readOnly: true example: 2 is_posted_to_loadboard: type: boolean readOnly: true default: false posted_to_loadboard_at: type: string format: date-time nullable: true readOnly: true example: "2019-11-15T10:33:29.112+0000" posting_url: description: The URL to the posted load type: string nullable: true readOnly: true example: "s.super-lb.com/aBcDe" is_flagged: type: boolean readOnly: true default: false is_on_hold: type: boolean readOnly: true default: false broker_fee: type: number format: float nullable: true example: 50 instructions: type: string nullable: true loadboard_instructions: type: string nullable: true payment: $ref: "#/paths/~1orders~1%7Bguid%7D~1mark_as_paid/put/requestBody/content/application~1json/schema" customer_payment: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/customer_payment" invoice: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/invoice" pickup: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/pickup" delivery: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/delivery" customer: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/customer" dispatch_sheet_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../dispatch-sheet.pdf" pdf_bol_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/BOL.pdf" pdf_bol_url_with_template: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/BOL.pdf" pdf_delivery_receipt_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/delivery-receipt.pdf" online_bol_url: type: string format: uri readOnly: true nullable: true example: "https://bol.superdispatch.com/f0446d" vehicles: type: array items: $ref: "#/paths/~1orders~1%7Border_guid%7D~1vehicles/post/requestBody/content/application~1json/schema" distance_meters: type: number format: float readOnly: true distance_duration_seconds: type: number format: int64 readOnly: true transport_type: type: string enum: - OPEN - ENCLOSED - DRIVEAWAY default: OPEN tags: type: array items: type: string example: - new - old "401": description: Not authenticated content: application/json: schema: $ref: "#/components/responses/ErrorResponse/content/application~1json/schema" "403": description: Forbidden content: application/json: schema: $ref: "#/components/responses/ErrorResponse/content/application~1json/schema" post: summary: Create a new order tags: - Orders requestBody: content: application/json: schema: type: object required: - number properties: number: type: string description: The order number that is used for invoicing or dispatching example: ORDER-4532 inspection_type: type: string enum: - standard - advanced - aiag description: "Different types of inspection. `standard` is a default inspection process that drivers perform on the mobile app. `advanced` requires the driver to add at least 6 photos, and have location information and geotagging enabled on their mobile app. `aiag` requires the driver to mark damages with AIAG Inspection Standard codes and take 2 photos. Read more: https://support.superdispatch.com/hc/en-us/articles/37239414473619-Inspection-Type-Options" is_status_changed_manually: type: boolean readOnly: true default: false purchase_order_number: type: string default: null nullable: true example: PO 0006 dispatcher_name: type: string nullable: true example: Sherry Turner sales_representative: type: string nullable: true example: Alma Dubois price: type: number format: float nullable: true example: 325 price_per_km: type: number format: float nullable: true readOnly: true example: 2 is_posted_to_loadboard: type: boolean readOnly: true default: false posted_to_loadboard_at: type: string format: date-time nullable: true readOnly: true example: "2019-11-15T10:33:29.112+0000" is_flagged: type: boolean readOnly: true default: false is_on_hold: type: boolean readOnly: true default: false broker_fee: type: number format: float nullable: true example: 50 instructions: type: string nullable: true loadboard_instructions: type: string nullable: true description: These instructions are shown on Super Loadboard payment: $ref: "#/paths/~1orders~1%7Bguid%7D~1mark_as_paid/put/requestBody/content/application~1json/schema" customer_payment: type: object properties: tariff: type: number format: float nullable: true example: 3 deposit: type: number format: float nullable: true example: 140 amount: type: number format: float nullable: true example: 100 terms: type: string enum: - 2_days - 5_days - 7_days - 10_days - 15_days - 20_days - 30_days - 40_days - 45_days - ach - on_pickup - on_delivery - cash_on_pickup - check_on_pickup - cash_on_delivery - check_on_delivery - comchek - quick_pay - other nullable: true notes: type: string nullable: true example: "The company (broker, dealer, auction, rental company, etc.) that originated this dispatch sheet." method: type: string enum: - cash - check - cashiers_check - money_order - comchek - credit_card - direct_deposit - other nullable: true reference_number: type: string nullable: true received_date: type: string format: date-time nullable: true example: "2019-11-19T10:33:29.112+0000" invoice: allOf: - type: object properties: adjusted_invoice_date: type: string format: date-time example: "2019-11-19T10:33:29.112+0000" date: type: string format: date-time example: null number: type: string example: null sent_date: type: string format: date-time example: null url: type: string format: uri example: null readOnly: true pickup: type: object properties: first_available_pickup_date: type: string format: date-time nullable: true example: "2019-11-20T10:33:29.112+0000" scheduled_at: type: string format: date-time nullable: true example: "2019-11-20T10:33:29.112+0000" scheduled_ends_at: type: string format: date-time nullable: true example: "2019-11-22T10:33:29.112+0000" scheduled_at_by_customer: type: string format: date-time nullable: true example: "2019-11-20T10:33:29.112+0000" scheduled_ends_at_by_customer: type: string format: date-time nullable: true example: "2019-11-20T10:33:29.112+0000" scheduled_at_by_carrier: type: string format: date-time nullable: true readOnly: true example: "2019-11-15T10:33:29.112+0000" description: The updated date set by the carrier adjusted_date: type: string format: date-time readOnly: true nullable: true example: "2019-11-22T10:33:29.112+0000" notes: type: string nullable: true date_type: type: string description: Use `estimated` date-type to define a date range. Use other date-types to set a single date. enum: - estimated - exact - not_earlier_than - not_later_than completed_at: type: string format: date-time nullable: true readOnly: true example: "2019-11-15T10:33:29.112+0000" counterparty_guid: type: string format: uuid nullable: true description: "The `guid` of a customer or terminal to reuse their existing information. If `counterparty_guid` is specified and all other information omitted, all terminal information will be automatically filled by the system." example: 4f797316-63a8-432a-a4ef-2986b8occ89d save_as_new: type: boolean default: null nullable: true description: Save the information in `venue` as a terminal save_as_new_contact: type: boolean default: null nullable: true description: Save the information in `venue` as a new contact of the current terminal (based on `counterparty_guid`) venue: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/2" - type: object properties: name: type: string default: null nullable: true example: First Rate Choice business_type: $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/3/properties/business_type" contact_name: type: string nullable: true default: null example: Mary Johnson contact_title: type: string default: null nullable: true example: Billing contact_email: type: string nullable: true format: email default: null contact_phone: type: string nullable: true format: phone default: null example: 202-555-0147 contact_mobile_phone: type: string format: phone default: null nullable: true example: 202-555-0148 delivery: type: object properties: scheduled_at: type: string format: date-time nullable: true example: "2019-11-20T10:33:29.112+0000" scheduled_ends_at: type: string format: date-time nullable: true example: "2019-11-22T10:33:29.112+0000" scheduled_at_by_customer: type: string format: date-time nullable: true example: "2019-11-20T10:33:29.112+0000" scheduled_ends_at_by_customer: type: string format: date-time nullable: true example: "2019-11-20T10:33:29.112+0000" scheduled_at_by_carrier: type: string format: date-time nullable: true readOnly: true example: "2019-11-15T10:33:29.112+0000" description: The updated date set by the carrier adjusted_date: type: string format: date-time readOnly: true nullable: true example: "2019-11-22T10:33:29.112+0000" notes: type: string nullable: true date_type: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/pickup/properties/date_type" completed_at: type: string format: date-time nullable: true readOnly: true example: "2019-11-15T10:33:29.112+0000" counterparty_guid: type: string format: uuid nullable: true description: "The `guid` of a customer or terminal to reuse their existing information. If `counterparty_guid` is specified and all other information omitted, all terminal information will be automatically filled by the system." example: 4f797316-63a8-432a-a4ef-2986b8occ89d save_as_new: type: boolean default: null nullable: true description: Save the information in `venue` as a terminal save_as_new_contact: type: boolean default: null nullable: true description: Save the information in `venue` as a new contact of the current terminal or customer (based on `counterparty_guid`) venue: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/pickup/properties/venue" customer: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/2" - type: object properties: name: type: string nullable: true example: First Rate Choice business_type: $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/3/properties/business_type" email: type: string nullable: true format: email notes: type: string nullable: true example: Test note phone: type: string nullable: true example: 202-555-0173 counterparty_guid: type: string format: uuid nullable: true example: 4f797316-63a8-432a-a4ef-2986b8occ89d description: "The `guid` of a customer to reuse their existing information. If `counterparty_guid` is specified and all other information omitted, all customer information will be automatically filled by the system." save_as_new: type: boolean default: null nullable: true description: Save the given customer in the customers list - allOf: - type: object properties: contact_name: type: string nullable: true example: Alan Parrish description: Required in case "save_as_new_contact" is set to true contact_title: type: string nullable: true example: Billing contact_phone: type: string nullable: true example: 202-555-0173 contact_mobile_phone: type: string nullable: true example: 202-555-0174 contact_email: type: string format: email nullable: true example: frchoice@gmail.com counterparty_contact_guid: type: string format: uuid nullable: true example: 701f461d-1328-4a7b-a753-410dad35dba6 description: "The `guid` of a customer contact to reuse their existing information. If `counterparty_contact_guid` is specified and all other information omitted, all customer contact information will be automatically filled by the system." save_as_new_contact: type: boolean default: null nullable: true description: Save the given customer contact in the customer contact list dispatch_sheet_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../dispatch-sheet.pdf" pdf_bol_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/BOL.pdf" pdf_bol_url_with_template: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/BOL.pdf" pdf_delivery_receipt_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/delivery-receipt.pdf" online_bol_url: type: string format: uri readOnly: true nullable: true example: "https://bol.superdispatch.com/f0446d" vehicles: type: array items: $ref: "#/paths/~1orders~1%7Border_guid%7D~1vehicles/post/requestBody/content/application~1json/schema" distance_meters: type: number format: float readOnly: true distance_duration_seconds: type: number format: int64 readOnly: true transport_type: type: string enum: - OPEN - ENCLOSED - DRIVEAWAY default: OPEN tags: type: array items: type: string example: - new - old responses: "201": $ref: "#/paths/~1orders/get/responses/200" "400": description: Validation error content: application/json: schema: $ref: "#/components/responses/ErrorResponse/content/application~1json/schema" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" /orders/guid: parameters: - name: guid description: GUID of the requested object in: path required: true schema: type: string format: uuid example: ef2818b8-a55e-436a-a61e-993ae0470928 get: summary: Get order details tags: - Orders responses: "200": $ref: "#/paths/~1orders/get/responses/200" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" put: summary: Update order details tags: - Orders requestBody: content: application/json: schema: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema" responses: "200": $ref: "#/paths/~1orders/get/responses/200" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" patch: summary: Partially update order details tags: - Orders requestBody: content: application/merge-patch+json: schema: type: object properties: number: type: string description: The order number that is used for invoicing or dispatching example: ORDER-4532 inspection_type: type: string enum: - standard - advanced - aiag description: "Different types of inspection. `standard` is a default inspection process that drivers perform on the mobile app. `advanced` requires the driver to add at least 6 photos, and have location information and geotagging enabled on their mobile app. `aiag` requires the driver to mark damages with AIAG Inspection Standard codes and take 2 photos. Read more: https://support.superdispatch.com/hc/en-us/articles/37239414473619-Inspection-Type-Options" is_status_changed_manually: type: boolean readOnly: true default: false purchase_order_number: type: string default: null nullable: true example: PO 0006 dispatcher_name: type: string nullable: true example: Sherry Turner sales_representative: type: string nullable: true example: Alma Dubois price: type: number format: float nullable: true example: 325 price_per_km: type: number format: float nullable: true readOnly: true example: 2 is_posted_to_loadboard: type: boolean readOnly: true default: false posted_to_loadboard_at: type: string format: date-time nullable: true readOnly: true example: "2019-11-15T10:33:29.112+0000" is_flagged: type: boolean readOnly: true default: false is_on_hold: type: boolean readOnly: true default: false broker_fee: type: number format: float nullable: true example: 50 instructions: type: string nullable: true loadboard_instructions: type: string nullable: true payment: $ref: "#/paths/~1orders~1%7Bguid%7D~1mark_as_paid/put/requestBody/content/application~1json/schema" customer_payment: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/customer_payment" pickup: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/pickup" delivery: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/delivery" customer: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema/properties/customer" dispatch_sheet_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../dispatch-sheet.pdf" pdf_bol_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/BOL.pdf" pdf_bol_url_with_template: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/BOL.pdf" pdf_delivery_receipt_url: type: string format: uri readOnly: true nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/delivery-receipt.pdf" online_bol_url: type: string format: uri readOnly: true nullable: true example: "https://bol.superdispatch.com/f0446d" vehicles: type: array items: $ref: "#/paths/~1orders~1%7Border_guid%7D~1vehicles/post/requestBody/content/application~1json/schema" distance_meters: type: number format: float readOnly: true distance_duration_seconds: type: number format: int64 readOnly: true transport_type: type: string enum: - OPEN - ENCLOSED - DRIVEAWAY default: OPEN tags: type: array items: type: string example: - new - old responses: "200": $ref: "#/components/responses/OrderDetailsResponseUpdatedPartially" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" delete: summary: Delete an order tags: - Orders responses: "204": description: The order is deleted "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" /orders/guid/related_loads: parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" get: summary: Find related load GUIDs tags: - Loads responses: "200": description: OK - The list of related loads' GUIDs content: application/json: schema: type: object properties: status: type: string data: type: object properties: objects: type: array items: type: string pagination: $ref: "#/components/responses/WebhooksResponse/content/application~1json/schema/allOf/1/properties/data/properties/pagination" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{guid}/purchase_order_number": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" patch: summary: Update Purchase Order Number tags: - Orders requestBody: content: application/json: schema: type: object properties: purchase_order_number: type: string nullable: true responses: "204": description: Purchase Order Number is updated "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{guid}/activities": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" get: summary: Get order activities tags: - Orders responses: "200": $ref: "#/components/responses/OrderActivityListResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{guid}/bol": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" get: summary: Get the order BOL URL tags: - Orders responses: "200": $ref: "#/components/responses/BOLResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{guid}/mark_as_paid": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" put: summary: Mark an order as paid to the carrier tags: - Orders requestBody: content: application/json: schema: type: object oneOf: - $ref: "#/paths/~1orders~1%7Bguid%7D~1mark_as_paid/put/requestBody/content/application~1json/schema/components/schemas/OtherTerms" - $ref: "#/paths/~1orders~1%7Bguid%7D~1mark_as_paid/put/requestBody/content/application~1json/schema/components/schemas/ZelleTerms" - $ref: "#/paths/~1orders~1%7Bguid%7D~1mark_as_paid/put/requestBody/content/application~1json/schema/components/schemas/UshipTerms" - $ref: "#/paths/~1orders~1%7Bguid%7D~1mark_as_paid/put/requestBody/content/application~1json/schema/components/schemas/CashAppTerms" - $ref: "#/paths/~1orders~1%7Bguid%7D~1mark_as_paid/put/requestBody/content/application~1json/schema/components/schemas/VenmoTerms" - $ref: "#/paths/~1orders~1%7Bguid%7D~1mark_as_paid/put/requestBody/content/application~1json/schema/components/schemas/CreditCardTerms" - $ref: "#/paths/~1orders~1%7Bguid%7D~1mark_as_paid/put/requestBody/content/application~1json/schema/components/schemas/DirectDepositTerms" - $ref: "#/paths/~1orders~1%7Bguid%7D~1mark_as_paid/put/requestBody/content/application~1json/schema/components/schemas/ComchekTerms" - $ref: "#/paths/~1orders~1%7Bguid%7D~1mark_as_paid/put/requestBody/content/application~1json/schema/components/schemas/MoneyOrderTerms" - $ref: "#/paths/~1orders~1%7Bguid%7D~1mark_as_paid/put/requestBody/content/application~1json/schema/components/schemas/CashiersCheckTerms" - $ref: "#/paths/~1orders~1%7Bguid%7D~1mark_as_paid/put/requestBody/content/application~1json/schema/components/schemas/CheckTerms" - $ref: "#/paths/~1orders~1%7Bguid%7D~1mark_as_paid/put/requestBody/content/application~1json/schema/components/schemas/CashTerms" - $ref: "#/paths/~1orders~1%7Bguid%7D~1mark_as_paid/put/requestBody/content/application~1json/schema/components/schemas/SuperPayTerms" discriminator: propertyName: method mapping: other: "#/components/schemas/OtherTerms" zelle: "#/components/schemas/ZelleTerms" uship: "#/components/schemas/UshipTerms" cashapp: "#/components/schemas/CashAppTerms" venmo: "#/components/schemas/VenmoTerms" credit_card: "#/components/schemas/CreditCardTerms" direct_deposit: "#/components/schemas/DirectDepositTerms" ach: "#/components/schemas/ACHTerms" comchek: "#/components/schemas/ComchekTerms" money_order: "#/components/schemas/MoneyOrderTerms" cashiers_check: "#/components/schemas/CashiersCheckTerms" check: "#/components/schemas/CheckTerms" cash: "#/components/schemas/CashTerms" superpay: "#/components/schemas/SuperPayTerms" default: "#/components/schemas/CashTerms" components: schemas: CashTerms: type: object properties: method: description: Specifies how the carrier will be paid for the load. Each payment method supports a specific set of valid payment terms. type: string enum: - cash required: true terms: type: string required: true enum: - cash_on_pickup - cash_on_delivery - 2_days - 5_days description: Specifies when the payment will be made notes: type: string nullable: true example: "The company (broker, dealer, auction, rental company, etc.) that originated this dispatch sheet." amount: type: number format: float nullable: true example: 550 reference_number: type: string nullable: true example: YWO-0293 sent_date: type: string format: date-time nullable: true example: "2019-11-19T10:33:29.112+0000" CheckTerms: type: object properties: method: description: Specifies how the carrier will be paid for the load. Each payment method supports a specific set of valid payment terms. type: string enum: - check required: true terms: type: string required: true enum: - check_on_pickup - check_on_delivery - 2_days - 5_days - 7_days - 10_days - 15_days - 20_days - 30_days - 45_days - 60_days description: Specifies when the payment will be made notes: type: string nullable: true example: "The company (broker, dealer, auction, rental company, etc.) that originated this dispatch sheet." amount: type: number format: float nullable: true example: 550 reference_number: type: string nullable: true example: YWO-0293 sent_date: type: string format: date-time nullable: true example: "2019-11-19T10:33:29.112+0000" CashiersCheckTerms: type: object properties: method: description: Specifies how the carrier will be paid for the load. Each payment method supports a specific set of valid payment terms. type: string enum: - cashiers_check required: true terms: type: string required: true enum: - check_on_pickup - check_on_delivery - 2_days - 5_days - 7_days - 10_days - 15_days - 20_days - 30_days - 45_days - 60_days description: Specifies when the payment will be made notes: type: string nullable: true example: "The company (broker, dealer, auction, rental company, etc.) that originated this dispatch sheet." amount: type: number format: float nullable: true example: 550 reference_number: type: string nullable: true example: YWO-0293 sent_date: type: string format: date-time nullable: true example: "2019-11-19T10:33:29.112+0000" MoneyOrderTerms: type: object properties: method: description: Specifies how the carrier will be paid for the load. Each payment method supports a specific set of valid payment terms. type: string enum: - money_order required: true terms: type: string required: true enum: - check_on_pickup - check_on_delivery - 2_days - 5_days - 7_days - 10_days - 15_days - 20_days - 30_days - 45_days - 60_days description: Specifies when the payment will be made notes: type: string nullable: true example: "The company (broker, dealer, auction, rental company, etc.) that originated this dispatch sheet." amount: type: number format: float nullable: true example: 550 reference_number: type: string nullable: true example: YWO-0293 sent_date: type: string format: date-time nullable: true example: "2019-11-19T10:33:29.112+0000" ComchekTerms: type: object properties: method: description: Specifies how the carrier will be paid for the load. Each payment method supports a specific set of valid payment terms. type: string enum: - comchek required: true terms: type: string required: true enum: - check_on_pickup - check_on_delivery - 2_days - 5_days - 7_days - 10_days - 15_days - 20_days - 30_days - 45_days - 60_days description: Specifies when the payment will be made notes: type: string nullable: true example: "The company (broker, dealer, auction, rental company, etc.) that originated this dispatch sheet." amount: type: number format: float nullable: true example: 550 reference_number: type: string nullable: true example: YWO-0293 sent_date: type: string format: date-time nullable: true example: "2019-11-19T10:33:29.112+0000" ACHTerms: type: object properties: method: description: Specifies how the carrier will be paid for the load. Each payment method supports a specific set of valid payment terms. type: string enum: - ach required: true terms: type: string required: true enum: - on_pickup - on_delivery - 2_days - 5_days - 7_days - 10_days - 15_days - 20_days - 30_days - 45_days - 60_days description: Specifies when the payment will be made notes: type: string nullable: true example: "The company (broker, dealer, auction, rental company, etc.) that originated this dispatch sheet." amount: type: number format: float nullable: true example: 550 reference_number: type: string nullable: true example: YWO-0293 sent_date: type: string format: date-time nullable: true example: "2019-11-19T10:33:29.112+0000" DirectDepositTerms: type: object properties: method: description: Specifies how the carrier will be paid for the load. Each payment method supports a specific set of valid payment terms. type: string enum: - direct_deposit required: true terms: type: string required: true enum: - on_pickup - on_delivery - 2_days - 5_days - 7_days - 10_days - 15_days - 20_days - 30_days - 45_days - 60_days description: Specifies when the payment will be made notes: type: string nullable: true example: "The company (broker, dealer, auction, rental company, etc.) that originated this dispatch sheet." amount: type: number format: float nullable: true example: 550 reference_number: type: string nullable: true example: YWO-0293 sent_date: type: string format: date-time nullable: true example: "2019-11-19T10:33:29.112+0000" CreditCardTerms: type: object properties: method: description: Specifies how the carrier will be paid for the load. Each payment method supports a specific set of valid payment terms. type: string enum: - credit_card terms: type: string required: true enum: - on_pickup - on_delivery - 2_days - 5_days - 7_days - 10_days - 15_days - 20_days - 30_days - 45_days - 60_days description: Specifies when the payment will be made notes: type: string nullable: true example: "The company (broker, dealer, auction, rental company, etc.) that originated this dispatch sheet." amount: type: number format: float nullable: true example: 550 reference_number: type: string nullable: true example: YWO-0293 sent_date: type: string format: date-time nullable: true example: "2019-11-19T10:33:29.112+0000" VenmoTerms: type: object properties: method: description: Specifies how the carrier will be paid for the load. Each payment method supports a specific set of valid payment terms. type: string enum: - venmo terms: type: string required: true enum: - on_pickup - on_delivery - 2_days - 5_days - 7_days - 10_days - 15_days - 20_days - 30_days - 45_days - 60_days description: Specifies when the payment will be made notes: type: string nullable: true example: "The company (broker, dealer, auction, rental company, etc.) that originated this dispatch sheet." amount: type: number format: float nullable: true example: 550 reference_number: type: string nullable: true example: YWO-0293 sent_date: type: string format: date-time nullable: true example: "2019-11-19T10:33:29.112+0000" CashAppTerms: type: object properties: method: description: Specifies how the carrier will be paid for the load. Each payment method supports a specific set of valid payment terms. type: string enum: - cashapp terms: type: string required: true enum: - on_pickup - on_delivery - 2_days - 5_days - 7_days - 10_days - 15_days - 20_days - 30_days - 45_days - 60_days description: Specifies when the payment will be made notes: type: string nullable: true example: "The company (broker, dealer, auction, rental company, etc.) that originated this dispatch sheet." amount: type: number format: float nullable: true example: 550 reference_number: type: string nullable: true example: YWO-0293 sent_date: type: string format: date-time nullable: true example: "2019-11-19T10:33:29.112+0000" UshipTerms: type: object properties: method: description: Specifies how the carrier will be paid for the load. Each payment method supports a specific set of valid payment terms. type: string enum: - uship required: true terms: type: string required: true enum: - on_pickup - on_delivery - 2_days - 5_days - 7_days - 10_days - 15_days - 20_days - 30_days - 45_days - 60_days description: Specifies when the payment will be made notes: type: string nullable: true example: "The company (broker, dealer, auction, rental company, etc.) that originated this dispatch sheet." amount: type: number format: float nullable: true example: 550 reference_number: type: string nullable: true example: YWO-0293 sent_date: type: string format: date-time nullable: true example: "2019-11-19T10:33:29.112+0000" ZelleTerms: type: object properties: method: description: Specifies how the carrier will be paid for the load. Each payment method supports a specific set of valid payment terms. type: string enum: - zelle required: true terms: type: string required: true enum: - on_pickup - on_delivery - 2_days - 5_days - 7_days - 10_days - 15_days - 20_days - 30_days - 45_days - 60_days description: Specifies when the payment will be made notes: type: string nullable: true example: "The company (broker, dealer, auction, rental company, etc.) that originated this dispatch sheet." amount: type: number format: float nullable: true example: 550 reference_number: type: string nullable: true example: YWO-0293 sent_date: type: string format: date-time nullable: true example: "2019-11-19T10:33:29.112+0000" SuperPayTerms: type: object properties: method: description: Specifies how the carrier will be paid for the load. Each payment method supports a specific set of valid payment terms. type: string enum: - superpay required: true terms: type: string required: true enum: - 1_3_days - 5_days - 10_days - 15_days - 20_days - 30_days description: Specifies when the payment will be made notes: type: string nullable: true example: "The company (broker, dealer, auction, rental company, etc.) that originated this dispatch sheet." amount: type: number format: float nullable: true example: 550 reference_number: type: string nullable: true example: YWO-0293 sent_date: type: string format: date-time nullable: true example: "2025-07-01T10:33:29.112+0000" OtherTerms: type: object properties: method: description: Specifies how the carrier will be paid for the load. Each payment method supports a specific set of valid payment terms. type: string enum: - other required: true terms: type: string required: true enum: - other - ach - cash_on_pickup - cash_on_delivery - quickpay - check_on_pickup - check_on_delivery - 2_days - 5_days - 7_days - 10_days - 15_days - 20_days - 30_days - 45_days - 60_days description: Specifies when the payment will be made notes: type: string nullable: true example: "The company (broker, dealer, auction, rental company, etc.) that originated this dispatch sheet." amount: type: number format: float nullable: true example: 550 reference_number: type: string nullable: true example: YWO-0293 sent_date: type: string format: date-time nullable: true example: "2019-11-19T10:33:29.112+0000" responses: "200": $ref: "#/paths/~1orders/get/responses/200" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{guid}/unmark_as_paid": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" put: summary: Unmark an order as paid to the carrier tags: - Orders responses: "200": $ref: "#/components/responses/OrderDetailsResponseUnmarkedAsPaid" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{guid}/payment": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" put: summary: Update the carrier payment tags: - Orders requestBody: content: application/json: schema: type: object properties: notes: type: string nullable: true example: "The company (broker, dealer, auction, rental company, etc.) that originated this dispatch sheet." method: type: string enum: - cash - check - cashiers_check - money_order - comchek - credit_card - direct_deposit - venmo - cashapp - uship - zelle - other nullable: true amount: type: number format: float nullable: true example: 550 reference_number: type: string nullable: true example: YWO-0293 sent_date: type: string format: date-time nullable: true example: "2023-05-15T10:33:29.112+0000" responses: "200": $ref: "#/paths/~1orders/get/responses/200" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/find_by_lot_number/{lot_number}": parameters: - name: lot_number in: path required: true schema: type: string get: summary: Search orders by a lot number tags: - Orders responses: "200": $ref: "#/components/responses/OrderListWithShortDetailsResponse" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/find_by_vin/{vin}": parameters: - name: vin in: path required: true schema: type: string example: 1G8AL52F03Z157046 get: summary: Search orders by a VIN tags: - Orders responses: "200": $ref: "#/components/responses/OrderListWithShortDetailsResponse" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{guid}/cancel": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" post: summary: Cancel an order tags: - Orders responses: "200": $ref: "#/components/responses/CanceledOrderResponse" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{guid}/mark_as_on_hold": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" put: summary: Mark order as on hold tags: - Orders responses: "204": description: Order is marked as on hold "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{guid}/archive": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" put: summary: Archive an order tags: - Orders responses: "204": description: The order is archived "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{guid}/unarchive": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" put: summary: Unarchive an order tags: - Orders responses: "204": description: The order is unarchived "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{guid}/mark_as_accepted": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" put: summary: Manually mark order as accepted tags: - Orders requestBody: content: application/json: schema: type: object required: - carrier_phone - carrier_email properties: carrier_address: type: string nullable: true example: 2705 Gordon Street carrier_city: type: string nullable: true example: WINTER HAVEN carrier_contact_name: type: string nullable: true example: Eric Harris carrier_email: type: string nullable: false example: example@classesmail.com carrier_guid: type: string format: uuid nullable: true example: ef2818b8-a55e-436a-a61e-993ae0470928 carrier_name: type: string nullable: true example: Mega Fast Trucks Inc carrier_phone: type: string nullable: false example: 909-562-7548 carrier_state: type: string nullable: true example: FL carrier_usdot: type: string nullable: true example: string carrier_zip: type: string nullable: true example: 33881 responses: "200": $ref: "#/components/responses/OrderDetailsResponseAcceptedManually" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{guid}/mark_as_picked_up": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" put: summary: Manually mark order as picked up tags: - Orders requestBody: content: application/json: schema: type: object required: - adjusted_date properties: adjusted_date: type: string format: date-time nullable: false example: "2019-11-19T10:33:29.112+0000" responses: "200": $ref: "#/components/responses/OrderDetailsResponsePickedUpManually" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{guid}/mark_as_delivered": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" put: summary: Manually mark order as delivered tags: - Orders requestBody: content: application/json: schema: type: object required: - adjusted_delivery_date - adjusted_pickup_date properties: adjusted_pickup_date: type: string format: date-time nullable: false example: "2019-11-19T10:33:29.112+0000" description: "REQUIRED only if order has no `adjusted_date` or `completed_at` pickup dates. Otherwise, the value will not be overwritten." adjusted_delivery_date: type: string format: date-time nullable: false example: "2019-11-19T10:33:29.112+0000" responses: "200": $ref: "#/components/responses/OrderDetailsResponseDeliveredManually" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{guid}/mark_as_carrier_invoiced": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" put: summary: Manually mark order as carrier invoiced tags: - Orders requestBody: content: application/json: schema: type: object required: - adjusted_invoice_date properties: adjusted_invoice_date: type: string format: date-time nullable: false example: "2019-11-19T10:33:29.112+0000" responses: "200": $ref: "#/components/responses/OrderDetailsResponseInvoicedManually" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{guid}/rollback_manual_status_change": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" put: summary: Rollback manually chaged status tags: - Orders responses: "200": $ref: "#/components/responses/OrderDetailsResponseRollbackManually" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{guid}/tags": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" get: summary: Find order tags by order guid tags: - Tags responses: "200": description: The list of order tag names content: application/json: schema: type: object properties: status: type: string data: type: object properties: objects: type: array items: type: string "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{order_guid}/vehicles": parameters: - $ref: "#/components/parameters/order_guid" post: summary: Create a new vehicle tags: - Vehicles requestBody: content: application/json: schema: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/0" - type: object properties: created_at: type: string format: date-time readOnly: true example: "2019-11-15T10:33:29.112+0000" changed_at: type: string format: date-time readOnly: true example: "2019-11-15T10:33:29.112+0000" guid: type: string format: uuid readOnly: true - type: object properties: status: type: string example: new nullable: false vin: type: string maxLength: 50 nullable: true example: 1G8AL52F03Z157046 year: type: number format: int32 nullable: true example: 2012 make: type: string maxLength: 50 nullable: true example: BMW model: type: string maxLength: 100 nullable: true example: X6 color: type: string maxLength: 100 nullable: true curb_weight: type: string maxLength: 20 nullable: true example: 2729 curb_weight_unit: type: string maxLength: 20 nullable: true example: lbs inspection_type: type: string enum: - standard - advanced - aiag default: standard is_damaged: type: boolean default: false readOnly: true is_modified: type: boolean is_driveaway: type: boolean default: false readOnly: true is_inoperable: type: boolean default: false lot_number: type: string maxLength: 100 nullable: true photos: type: array items: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - type: object properties: guid: type: string example: 5b85f3a6-728d-46f7-b2e2-4087b5ca4937 photo_type: type: string enum: - Sample - Pickup - Delivery example: Delivery photo_url: type: string format: uri nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/photo1.jpeg" rendered_photo_url: type: string format: uri nullable: true example: "https://storage.googleapis.com/.../f0446dc5-1e30-4c5d-8fe7-d3b88c7174ae/rendered-photo1.jpeg" latitude: type: number example: 39.0938064 longitude: type: number example: -94.5853684 readOnly: true price: type: number format: float nullable: true example: 60 requires_enclosed_trailer: type: boolean default: false readOnly: true tariff: type: number format: float nullable: true example: 3 type: nullable: true type: string enum: - sedan - 2_door_coupe - suv - pickup - 4_door_pickup - van - truck_daycab - truck_sleeper - motorcycle - boat - rv - heavy_machinery - freight - livestock - atv - trailer_bumper_pull - trailer_gooseneck - trailer_5th_wheel - other responses: "201": $ref: "#/components/responses/VehicleDetailsResponse" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "/orders/{order_guid}/vehicles/{guid}": parameters: - $ref: "#/components/parameters/order_guid" - $ref: "#/paths/~1orders~1guid/parameters/0" get: summary: Get vehicle details tags: - Vehicles responses: "200": $ref: "#/components/responses/VehicleDetailsResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" put: summary: Update vehicle details tags: - Vehicles requestBody: content: application/json: schema: $ref: "#/paths/~1orders~1%7Border_guid%7D~1vehicles/post/requestBody/content/application~1json/schema" responses: "200": $ref: "#/components/responses/VehicleDetailsResponse" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" delete: summary: Delete a vehicle tags: - Vehicles responses: "204": description: The vehicle is deleted "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{order_guid}/vehicles/{guid}/bol": parameters: - $ref: "#/components/parameters/order_guid" - $ref: "#/paths/~1orders~1guid/parameters/0" get: summary: Get the vehicle BOL URL tags: - Vehicles responses: "200": $ref: "#/components/responses/BOLResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{order_guid}/vehicles/{guid}/broker_bol": parameters: - $ref: "#/components/parameters/order_guid" - $ref: "#/paths/~1orders~1guid/parameters/0" get: summary: Get the vehicle broker BOL URL tags: - Vehicles responses: "200": $ref: "#/components/responses/BOLResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{order_guid}/vehicles/{guid}/aiag_inspection": parameters: - $ref: "#/components/parameters/order_guid" - $ref: "#/paths/~1orders~1guid/parameters/0" get: summary: Get AIAG inspection details tags: - Vehicles responses: "200": $ref: "#/components/responses/AIAGInspectionDetailsResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{order_guid}/vehicles/{guid}/photos/sample": parameters: - $ref: "#/components/parameters/order_guid" - $ref: "#/components/parameters/vehicle_guid" post: summary: Add vehicle sample photo tags: - Vehicles requestBody: content: multipart/form-data: schema: type: object properties: file: type: binary responses: "201": $ref: "#/components/responses/VehicleSamplePhotoResponse" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" delete: summary: Delete vehicle sample photo tags: - Vehicles responses: "204": description: The sample photo is deleted "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{order_guid}/attachments": parameters: - $ref: "#/components/parameters/order_guid" get: summary: Get order attachments tags: - Attachments responses: "200": $ref: "#/components/responses/AttachmentListResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" post: summary: Create a new order attachment parameters: - name: is_shared_with_customer in: query required: false description: Share this attachment with customer schema: type: boolean default: false - name: is_shared_with_carrier in: query required: false description: Share this attachment with carrier schema: type: boolean default: true - name: is_location_protected in: query required: false description: Protect the GPS location metadata embedded in the uploaded photo. schema: type: boolean default: false tags: - Attachments requestBody: content: multipart/form-data: schema: type: object properties: file: type: string format: binary responses: "201": $ref: "#/components/responses/AttachmentDetailsResponse" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "/vehicles/{vehicleGuid}/attachments": parameters: - $ref: "#/components/parameters/vehicle_guid" post: summary: Create a new vehicle attachment parameters: - name: attachment_type in: query required: false description: 'Vehicle attachment type. The type "gate pass" is shared with the customer and carrier, and the type "other" doesn''t share.' schema: type: string enum: - other - gate_pass tags: - Attachments requestBody: content: multipart/form-data: schema: type: object properties: file: type: string format: binary responses: "201": $ref: "#/components/responses/AttachmentDetailsResponse" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "/orders/{order_guid}/attachments/{guid}": parameters: - $ref: "#/components/parameters/order_guid" - $ref: "#/paths/~1orders~1guid/parameters/0" get: summary: Get order attachment details deprecated: true tags: - Attachments responses: "200": $ref: "#/components/responses/AttachmentDetailsResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" delete: summary: Delete order an attachment deprecated: true tags: - Attachments responses: "204": description: The attachment is deleted "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/attachments/{guid}": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" get: summary: Get attachment details tags: - Attachments responses: "200": $ref: "#/components/responses/AttachmentDetailsResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" delete: summary: Delete an attachment tags: - Attachments responses: "204": description: The attachment is deleted "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{order_guid}/comments": parameters: - $ref: "#/components/parameters/order_guid" get: summary: Get order comments tags: - Comments responses: "200": $ref: "#/components/responses/CommentListDetailsResponse" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" post: summary: Create a new comment tags: - Comments requestBody: content: application/json: schema: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/0" - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - type: object required: - note properties: note: type: string responses: "201": $ref: "#/components/responses/CommentDetailsResponse" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "/orders/{order_guid}/comments/{guid}": parameters: - $ref: "#/components/parameters/order_guid" - $ref: "#/paths/~1orders~1guid/parameters/0" put: summary: Update comment tags: - Comments requestBody: content: application/json: schema: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/0" - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - type: object properties: note: type: string guid: type: string responses: "200": $ref: "#/components/responses/CommentDetailsResponse" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" delete: summary: Delete a comment tags: - Comments responses: "204": description: The comment is deleted "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{order_guid}/offers": parameters: - $ref: "#/components/parameters/order_guid" get: summary: Get order offers tags: - Offers responses: "200": $ref: "#/components/responses/OfferListResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" post: summary: Send a load offer tags: - Offers - Shipper-to-Broker flow description: "This endpoint is used to send load offers to a carrier or broker. Please pay attention to the `carrier_type` field. The default value of the field is `CTMS`, which means the offer is sent to a carrier. If you want to send the offer to a broker, you should set the field to `BROKER`." requestBody: content: application/json: schema: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/0" - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - type: object properties: carrier_guid: type: string format: uuid description: The carrier GUID is used to find a carrier or retrieve the carrier details. REQUIRED if carrier's GUID is known. carrier_type: type: string enum: - CTMS - BROKER nullable: true description: The carrier type. The default value `CTMS`. For shipper-to-broker flow pass `BROKER`. carrier_usdot: type: string example: 12345 description: The carrier USDOT number is used to find a carrier to send a load offer. REQUIRED if carrier's GUID is unknown. carrier_email: type: string format: email description: "The carrier email is used to create an offer for a carrier that is not yet registered in Super Dispatch. If a carrier is already registered in Super Dispatch, this field will be ignored." nullable: true minLength: 1 maxLength: 100 carrier_phone: type: string format: phone example: 18123456789 description: "The carrier phone is used to create an offer for a carrier that is not yet registered in Super Dispatch. If a carrier is already registered in Super Dispatch, this field will be ignored." nullable: true minLength: 1 maxLength: 150 responses: "201": $ref: "#/components/responses/OfferDetailsResponse" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" /brokers/linked: get: summary: Get linked brokers tags: - Shipper-to-Broker flow parameters: - $ref: "#/paths/~1webhooks/parameters/0" - $ref: "#/paths/~1webhooks/parameters/1" responses: "200": description: Linked brokers list content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: objects: type: array items: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/2" - type: object required: - guid - name - email properties: guid: type: string example: 644f255f-81a3-45bb-b89b-708df891b425 name: type: string example: First Rate Choice email: type: string format: email us_dot: type: string nullable: true example: "902345482" phone: type: string nullable: true example: "+12025550173" contact_name: type: string nullable: true example: John Adams pagination: $ref: "#/components/responses/WebhooksResponse/content/application~1json/schema/allOf/1/properties/data/properties/pagination" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" /orders/submit_to_broker: parameters: - name: broker_guid in: query description: "The GUID of the broker to submit the order to. If not provided, the order is submitted to the existing broker." required: false schema: type: string example: 12345678-1234-1234-1234-123456789012 post: summary: Submit order description: "Create a new order and automatically send a load offer to a linked broker. If `broker_guid` is not provided, and the linked brokers count is more than one or there are no linked brokers, then an error will be thrown." tags: - Shipper-to-Broker flow requestBody: content: application/json: schema: $ref: "#/paths/~1orders/post/requestBody/content/application~1json/schema" responses: "201": $ref: "#/paths/~1orders/get/responses/200" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "/escalations/orders/{guid}/submit": parameters: - name: guid in: query description: The GUID of the order to submit an escalation required: true schema: type: string format: uuid example: 12345678-1234-1234-1234-123456789012 post: summary: Submit an escalation requestBody: content: application/json: schema: $ref: "#/paths/~1escalations~1%7Bguid%7D~1resolve/post/requestBody/content/application~1json/schema" tags: - Shipper-to-Broker flow responses: "200": description: Submit escalation response content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: type: object description: Submit escalation response properties: guid: description: Escalation guid type: string format: uuid example: 5f1ade75-74a6-4a6a-9ade-7574a6ea6ae9 order_guid: description: Order guid type: string format: uuid example: f227ed3a-6ba8-43d7-a7ed-3a6ba8b3d79d "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/escalations/{guid}/resolve": parameters: - name: guid in: query description: The GUID of the escalation to resolve required: true schema: type: string example: 12345678-1234-1234-1234-123456789012 post: summary: Resolve an escalation requestBody: content: application/json: schema: type: object properties: reasons: type: object description: Map of reasons. The key is the reason code and the value is the reason description. properties: CHARGES_DUE: type: string example: charges due reason VEHICLE_IS_NOT_AT_LOCATION: type: string example: vehicle is not at location reason INCORRECT_PHONE_NUMBER: type: string example: incorrect phone number reason LOCATION_WILL_NOT_RELEASE: type: string example: location will not release reason LOCATION_CHANGED: type: string example: location changed reason NO_RETURNED_CALLS_OR_EMAILS: type: string example: no returned calls or emails reason OTHER: type: string example: other reason tags: - Shipper-to-Broker flow responses: "200": description: The escalation is resolved "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{order_guid}/offers/{guid}": parameters: - $ref: "#/components/parameters/order_guid" - $ref: "#/paths/~1orders~1guid/parameters/0" get: summary: Get offer details tags: - Offers responses: "200": $ref: "#/components/responses/OfferDetailsResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{order_guid}/offers/{guid}/cancel": parameters: - $ref: "#/components/parameters/order_guid" - $ref: "#/paths/~1orders~1guid/parameters/0" put: summary: Cancel a load offer tags: - Offers responses: "200": $ref: "#/components/responses/OfferDetailsResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{order_guid}/cancel_active_offer": parameters: - $ref: "#/components/parameters/order_guid" put: summary: Cancel active load offer by order GUID tags: - Offers responses: "200": $ref: "#/components/responses/OfferDetailsResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{order_guid}/offers/active": parameters: - $ref: "#/components/parameters/order_guid" get: summary: Get the active load offer of a specific order tags: - Offers responses: "200": $ref: "#/components/responses/OfferDetailsResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{order_guid}/requests/{request_guid}/counter-offer": parameters: - $ref: "#/components/parameters/order_guid" - $ref: "#/components/parameters/request_guid" post: summary: Send a counter offer to the load request tags: - Offers responses: "200": $ref: "#/components/responses/OfferDetailsResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{order_guid}/requests/{request_guid}/counter-offer/cancel": parameters: - $ref: "#/components/parameters/order_guid" - $ref: "#/components/parameters/request_guid" patch: summary: Cancel a counter offer for the load request tags: - Offers responses: "200": $ref: "#/components/responses/OfferDetailsResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/loadboard/orders/{guid}/private-network": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" post: summary: Post the order to private network tags: - Loadboard integration responses: "204": description: The order is posted to Loadboard "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "409": description: Conflict in the request content: application/json: schema: $ref: "#/components/responses/ErrorResponse/content/application~1json/schema" "/loadboard/orders/{guid}/private-network/{group_guid}": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" - name: group_guid in: query required: false schema: type: string format: uuid example: ef2818b8-a55e-436a-a61e-993ae0470928 post: summary: Post the order to private network group tags: - Loadboard integration responses: "204": description: The order is posted to Loadboard "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "409": $ref: "#/paths/~1loadboard~1orders~1%7Bguid%7D~1private-network/post/responses/409" "/loadboard/orders/{guid}": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" post: summary: Post the order to Loadboard tags: - Loadboard integration responses: "204": description: The order is posted to Loadboard "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" delete: summary: Remove (unpost) the order from Loadboard tags: - Loadboard integration responses: "204": description: The order is unposted from Loadboard "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "/orders/{order_guid}/requests/{request_guid}/accept": parameters: - $ref: "#/components/parameters/order_guid" - $ref: "#/components/parameters/request_guid" put: summary: Accept a load request tags: - Loadboard integration responses: "200": $ref: "#/components/responses/LoadRequestAcceptedResponse" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "/orders/{order_guid}/requests/{request_guid}/decline": parameters: - $ref: "#/components/parameters/order_guid" - $ref: "#/components/parameters/request_guid" put: summary: Decline a load request tags: - Loadboard integration requestBody: content: application/json: schema: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/0" - type: object properties: decline_reason: type: string example: Reason nullable: true responses: "200": $ref: "#/components/responses/LoadRequestDeclinedResponse" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" /orders/price_negotiations: post: tags: - Price negotiation summary: Create price negotiation operationId: savePriceNegotiation requestBody: content: application/json: schema: allOf: - type: object properties: order_guid: type: string nullable: false negotiation_budget: minimum: 1 exclusiveMinimum: false type: number nullable: false increase_by_percent: maximum: 100 exclusiveMaximum: false minimum: 1 exclusiveMinimum: false type: number increase_every: allOf: - type: object properties: value: type: integer format: int32 nullable: false unit: type: string nullable: false enum: - DAYS start_date: format: date-time example: "2020-02-15T00:00:00.112+0000" description: Cannot be earlier than the order creation date. Default value is order creation date. acceptable_pickup_days: type: number minimum: 0 maximum: 3 description: Acceptable days extends the pickup range until the end of the day. acceptable_delivery_days: type: number minimum: 0 maximum: 3 description: Acceptable days extends the delivery range until the end of the day. required: true responses: "201": description: Created content: application/json: schema: allOf: - type: object properties: order_guid: type: string nullable: false negotiation_budget: minimum: 1 exclusiveMinimum: false type: number nullable: false increase_by_percent: maximum: 100 exclusiveMaximum: false minimum: 1 exclusiveMinimum: false type: number increase_every: $ref: "#/paths/~1orders~1price_negotiations/post/requestBody/content/application~1json/schema/allOf/0/properties/increase_every" start_date: format: date-time example: "2020-02-15T00:00:00.112+0000" description: Cannot be earlier than the order creation date. Default value is order creation date. acceptable_pickup_days: type: number minimum: 0 maximum: 3 description: Acceptable days extends the pickup range until the end of the day. acceptable_delivery_days: type: number minimum: 0 maximum: 3 description: Acceptable days extends the delivery range until the end of the day. "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "/orders/price_negotiations/{guid}": get: tags: - Price negotiation summary: Find price negotiation by guid operationId: findPriceNegotiationByGuid parameters: - name: guid in: path required: true schema: type: string responses: "200": description: OK content: application/json: schema: $ref: "#/paths/~1orders~1price_negotiations/post/responses/201/content/application~1json/schema" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" put: tags: - Price negotiation summary: Update price negotiation operationId: updatePriceNegotiation parameters: - name: guid in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/paths/~1orders~1price_negotiations/post/requestBody/content/application~1json/schema" required: true responses: "200": description: OK content: application/json: schema: $ref: "#/paths/~1orders~1price_negotiations/post/responses/201/content/application~1json/schema" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "/orders/price_negotiations/{guid}/disable": put: tags: - Price negotiation summary: Disable price negotiation operationId: disablePriceNegotiation parameters: - name: guid in: path required: true schema: type: string responses: "204": description: No Content "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "/orders/price_negotiations/{guid}/enable": put: tags: - Price negotiation summary: Enable price negotiation operationId: enablePriceNegotiation parameters: - name: guid in: path required: true schema: type: string responses: "204": description: No Content "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "/orders/{order_guid}/price_negotiations": get: tags: - Price negotiation summary: Find price negotiations by order guid operationId: findPriceNegotiationByOrderGuid parameters: - name: orderGuid in: path required: true schema: type: string responses: "200": description: OK content: application/json: schema: type: array items: $ref: "#/paths/~1orders~1price_negotiations/post/responses/201/content/application~1json/schema" "/orders/{guid}/insurance": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" get: summary: Get insurance details for an order operationId: getOrderInsurance tags: - Integrated insurance description: | Returns the Shipper's Interest insurance state for an order, along with a personal link to the insurance portal where the policy can be reviewed, purchased, or claimed. This endpoint is read-only. It reports the draft policies that already exist; it does not create them. `personal_link` stays `null` until a draft exists, so call **Sync insurance policy** first for an order that has never been quoted. responses: "200": description: Insurance details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: type: object properties: is_insured: type: boolean description: At least one vehicle on the order has an issued policy example: true is_eligible_for_insurance: type: boolean description: The order still has vehicles that can be insured example: false cancelable: type: boolean description: The issued policy can still be canceled example: true personal_link: type: string nullable: true description: >- Signed link to the Tint portal for this order, where checkout is completed and the insurance is managed afterwards. `null` until a draft policy exists. example: "https://insurance.superdispatch.com/policies?token=eyJhbGciOiJIUzI1NiJ9" issued_vehicle_guids: type: array description: GUIDs of the order's vehicles that have an issued policy items: type: string format: uuid example: - cf175584-ed21-4a22-8474-7f44d413be22 "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/orders/{guid}/sync-insurance-policy": parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" post: summary: Sync insurance policy for an order operationId: syncOrderInsurancePolicy tags: - Integrated insurance description: | Reconciles the order's insurance with the insurer: creates a draft policy for every eligible vehicle that does not have one yet, and refreshes the drafts that already exist. Returns the same payload as **Get insurance details**, with `personal_link` populated once a draft exists. Call this before showing the personal link for an order that has never been quoted. The request body is empty. **Rate limited.** One call per order is accepted every 30 seconds; a call inside that window returns `429 RATE_LIMIT_EXCEEDED`. The window is consumed even when the sync itself fails, so retry after 30 seconds rather than immediately. responses: "200": description: Insurance details after the sync content: application/json: schema: $ref: "#/paths/~1orders~1%7Bguid%7D~1insurance/get/responses/200/content/application~1json/schema" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "429": description: Too many requests for this order. Retry after 30 seconds. content: application/json: schema: $ref: "#/components/responses/ErrorResponse/content/application~1json/schema" /insurances/quotes: post: summary: Calculate an insurance premium operationId: calculateInsurancePremium tags: - Integrated insurance description: | Calculates the Shipper's Interest premium for a single vehicle on a given route. The premium price is estimated from the vehicle's declared value and the distance between the pickup and delivery locations. Normally the insurer estimates that declared value itself from the vehicle details you send. A `value` you send is a fallback, used only when it cannot arrive at a figure, rather than an override — so it is not necessarily the figure the premium is based on. When the insurer cannot determine the value and no `value` was supplied, the request fails with `409 VEHICLE_VALUE_REQUIRED`. Retry with `vehicle.value` set. requestBody: required: true content: application/json: schema: type: object required: - pickup - delivery - vehicle properties: pickup: type: object required: - city - state properties: address: type: string maxLength: 500 description: >- Optional. Used only to geocode a more precise distance; it is not sent to the insurer. example: 1 Market St city: type: string maxLength: 100 example: San Francisco state: type: string minLength: 2 maxLength: 2 description: Two-letter state code example: CA zip: type: string nullable: true description: >- Optional US ZIP code (`12345` or `12345-6789`). When omitted, the distance is resolved by geocoding the city, state and address instead. example: "94102" delivery: $ref: "#/paths/~1insurances~1quotes/post/requestBody/content/application~1json/schema/properties/pickup" vehicle: type: object required: - year - make - model - vehicle_type properties: year: type: integer example: 2020 make: type: string example: Honda model: type: string example: Accord vehicle_type: type: string enum: - sedan - 2_door_coupe - suv - 4_door_pickup - pickup - van - truck_daycab - truck_sleeper - motorcycle - boat - rv - heavy_machinery - freight - livestock - atv - trailer_bumper_pull - trailer_gooseneck - trailer_5th_wheel - other example: sedan vin: type: string nullable: true description: >- Optional. Send it when you have it; a quote does not require one. example: JHMZE2H73AS009608 value: type: number nullable: true minimum: 0 exclusiveMinimum: true description: >- Optional declared value of the vehicle, in USD. Used only when the insurer cannot determine the value with its own tools. example: 25000 responses: "200": description: One quote per available insurance plan content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: objects: type: array items: type: object properties: plan_slug: type: string description: Identifier of the insurance plan the quote belongs to example: shippers-interest calculated_premium: type: number description: Premium for the plan, in USD example: 47.79 "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "409": description: >- The insurer could not determine the vehicle's value (`VEHICLE_VALUE_REQUIRED`). Retry with `vehicle.value` set. content: application/json: schema: $ref: "#/components/responses/ErrorResponse/content/application~1json/schema" /webhooks: parameters: - name: page description: The page number (index) to retrieve in: query required: false schema: type: integer format: int32 minimum: 0 default: 0 example: 0 - name: size description: The number of objects in the page in: query required: false schema: type: integer format: int32 minimum: 0 default: 20 example: 20 get: summary: Get the list of all webhooks subscriptions tags: - Webhooks responses: "200": $ref: "#/components/responses/WebhooksResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" /webhooks/action_types: get: summary: Get the list of all available webhook actions tags: - Webhooks responses: "200": $ref: "#/components/responses/WebhookActionListResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" /webhooks/failed_webhooks: parameters: - $ref: "#/paths/~1webhooks/parameters/0" - $ref: "#/paths/~1webhooks/parameters/1" - $ref: "#/components/parameters/start_date" - $ref: "#/components/parameters/end_date" get: summary: Get the list of failed webhooks by shipper between start and end date tags: - Webhooks responses: "200": $ref: "#/components/responses/FailedWebhooksResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "/webhooks/{action}": parameters: - name: action in: path required: true schema: type: string enum: - order.modified - offer.sent - offer.sent.failed - offer.accepted - offer.accepted.ignored - offer.updated_to_accepted - offer.updated_to_accepted.ignored - offer.declined - offer.declined.ignored - offer.canceled - order.created - order.cancel - order.submitted_by_customer - order.picked_up - order.picked_up.ignored - order.delivered - order.delivered.ignored - order.picked_up_bol - order.delivered_bol - order.paid - order.unmark_as_paid - order.customer_paid - order.invoiced - order.customer_invoiced - order.archived - order.marked_as_on_hold - order.unmarked_as_on_hold - order.unarchived - order.posted_to_slb - order.removed_from_slb - order.booked - load_request.declined_by_shipper - load_request.canceled_by_carrier - load_request.created - load_request.updated - order.manually_marked_as_new - order.manually_marked_as_pending - order.manually_marked_as_picked_up - order.manually_marked_as_delivered - order.manually_marked_as_accepted - order.manually_marked_as_invoiced - order.manually_unmarked_as_invoiced - order.rolled_back_manual_status_change - order.removed - order.restored - vehicle.created - vehicle.modified - vehicle.deleted - vehicle.pickup_eta_updated_by_driver - vehicle.delivery_eta_updated_by_driver - vehicle.gps_activated - vehicle.gps_deactivated readOnly: true get: summary: Get the webhook subscription by action tags: - Webhooks responses: "200": $ref: "#/components/responses/WebhookResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/webhooks/{action}/subscribe": parameters: - name: action in: path required: true schema: $ref: "#/paths/~1webhooks~1%7Baction%7D/parameters/0/schema" post: summary: Subscribe to a webhook action tags: - Webhooks requestBody: content: application/json: schema: allOf: - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/0" - $ref: "#/paths/~1customers/post/requestBody/content/application~1json/schema/allOf/1" - type: object properties: action: $ref: "#/paths/~1webhooks~1%7Baction%7D/parameters/0/schema" verification_token: type: string format: uuid readOnly: true description: The verification token callback_url: type: string description: The callback URL example: "https://webhook.site/f9698e2a-a70c-4630-8313-a0059516ba77" audit_field_set: type: array description: Contains the list of order or vehicle fields which values will be added to the webhook payload when it's triggered. example: - number - price - pickup.venue.name responses: "201": $ref: "#/components/responses/WebhookResponse" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "/webhooks/{action}/unsubscribe": parameters: - name: action in: path required: true schema: $ref: "#/paths/~1webhooks~1%7Baction%7D/parameters/0/schema" post: summary: Unsubscribe from a webhook action tags: - Webhooks responses: "204": description: Unsubscribed "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" /private-network/groups: get: summary: List all private network groups tags: - Carriers operationId: listPrivateNetworkGroups responses: "200": description: Private network group details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: objects: type: array items: $ref: "#/paths/~1carriers~1%7Bguid%7D~1profile/put/requestBody/content/application~1json/schema/properties/private_network_groups/items" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "409": $ref: "#/paths/~1loadboard~1orders~1%7Bguid%7D~1private-network/post/responses/409" post: summary: Create a new private network group tags: - Carriers operationId: createPrivateNetworkGroup requestBody: content: application/json: schema: type: object properties: name: type: string example: Can move EVs required: true responses: "200": description: Private network group details content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: $ref: "#/paths/~1carriers~1%7Bguid%7D~1profile/put/requestBody/content/application~1json/schema/properties/private_network_groups/items" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "409": $ref: "#/paths/~1loadboard~1orders~1%7Bguid%7D~1private-network/post/responses/409" "/private-network/groups/{guid}/": put: summary: Update the private network group tags: - Carriers operationId: updatePrivateNetworkGroup parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" requestBody: content: application/json: schema: type: object properties: name: type: string example: Can move EVs required: true responses: "200": $ref: "#/paths/~1private-network~1groups/post/responses/200" "400": $ref: "#/paths/~1orders/post/responses/400" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" "409": $ref: "#/paths/~1loadboard~1orders~1%7Bguid%7D~1private-network/post/responses/409" delete: summary: Delete the private network group tags: - Carriers operationId: deletePrivateNetworkGroup parameters: - $ref: "#/paths/~1orders~1guid/parameters/0" responses: "204": description: Private network group was deleted "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403" "404": $ref: "#/paths/~1customers/get/responses/404" /carriers/private-network: parameters: - $ref: "#/paths/~1webhooks/parameters/0" - $ref: "#/paths/~1webhooks/parameters/1" - $ref: "#/paths/~1loadboard~1orders~1%7Bguid%7D~1private-network~1%7Bgroup_guid%7D/parameters/1" get: summary: List of carriers in the private network tags: - Carriers responses: "200": description: Carrier profile content: application/json: schema: allOf: - $ref: "#/components/responses/BaseResponse/content/application~1json/schema" - type: object properties: data: type: object properties: object: $ref: "#/paths/~1carriers~1%7Bguid%7D~1profile/put/requestBody/content/application~1json/schema" "401": $ref: "#/paths/~1orders/get/responses/401" "403": $ref: "#/paths/~1orders/get/responses/403"