{"openapi":"3.1.0","info":{"title":"BiggerPicture API","version":"1.0.0"},"servers":[{"url":"https://app.biggerpicture.co/api/v1"}],"tags":[{"name":"user","description":"Endpoints to manage  users"},{"name":"shipment","description":"Endpoints to manage  shipments/orders"},{"name":"webhook","description":"Endpoints to manage your webhooks"},{"name":"appointment","description":"Endpoints to manage your appointments"},{"name":"carrier","description":"Endpoints to manage your carriers"},{"name":"customer","description":"Endpoints to manage your customers"}],"paths":{"/user/{userId}":{"get":{"operationId":"user-get","description":"Retrieves a given user of your organization","tags":["user"],"security":[{"Authorization":[]}],"parameters":[{"in":"path","name":"userId","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"role":{"anyOf":[{"type":"string","enum":["SuperAdmin","Admin","Member","Limited","ViewOnly","DistributionList"]},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["Active","Disabled","Invited"]},{"type":"null"}]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastName":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailVerified":{"anyOf":[{"type":"string"},{"type":"null"}]},"image":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"signature":{"type":"boolean"},"signatureImageUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"signatureDisclaimer":{"anyOf":[{"type":"string"},{"type":"null"}]},"organizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastActiveAt":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["role","status","id","name","lastName","email","emailVerified","image","phone","jobTitle","signature","signatureImageUrl","signatureDisclaimer","organizationId","createdAt","updatedAt","lastActiveAt"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.NOT_FOUND"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}},"patch":{"operationId":"user-update","description":"Updates a given user of your organization","tags":["user"],"security":[{"Authorization":[]}],"parameters":[{"in":"path","name":"userId","schema":{"type":"string"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","pattern":"^[a-zA-Z0-9._%+&'-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"},"name":{"type":"string","minLength":1},"lastName":{"type":"string"},"status":{"type":"string","enum":["Active","Disabled","Invited"]},"role":{"type":"string","enum":["SuperAdmin","Admin","Member","Limited","ViewOnly","DistributionList"]},"assignments":{"type":"array","items":{"type":"string"}},"phone":{"type":"string"},"jobTitle":{"type":"string"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"role":{"anyOf":[{"type":"string","enum":["SuperAdmin","Admin","Member","Limited","ViewOnly","DistributionList"]},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["Active","Disabled","Invited"]},{"type":"null"}]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastName":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailVerified":{"anyOf":[{"type":"string"},{"type":"null"}]},"image":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"signature":{"type":"boolean"},"signatureImageUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"signatureDisclaimer":{"anyOf":[{"type":"string"},{"type":"null"}]},"organizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastActiveAt":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["role","status","id","name","lastName","email","emailVerified","image","phone","jobTitle","signature","signatureImageUrl","signatureDisclaimer","organizationId","createdAt","updatedAt","lastActiveAt"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.NOT_FOUND"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}},"/user/{userId}/token":{"get":{"operationId":"user-token","description":"Retrieves a JWT authentificating this user. The token is valid for 1hour.","tags":["user"],"security":[{"Authorization":[]}],"parameters":[{"in":"path","name":"userId","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"}},"required":["token"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.NOT_FOUND"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}},"/user":{"post":{"operationId":"user-create","description":"Adds a user to your organization","tags":["user"],"security":[{"Authorization":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","pattern":"^[a-zA-Z0-9._%+&'-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"},"role":{"type":"string","enum":["SuperAdmin","Admin","Member","Limited","ViewOnly","DistributionList"]},"assignments":{"type":"array","items":{"type":"string"}},"name":{"type":"string","minLength":1},"lastName":{"type":"string"},"phone":{"type":"string"},"jobTitle":{"type":"string"}},"required":["email"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"role":{"anyOf":[{"type":"string","enum":["SuperAdmin","Admin","Member","Limited","ViewOnly","DistributionList"]},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["Active","Disabled","Invited"]},{"type":"null"}]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastName":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailVerified":{"anyOf":[{"type":"string"},{"type":"null"}]},"image":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"signature":{"type":"boolean"},"signatureImageUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"signatureDisclaimer":{"anyOf":[{"type":"string"},{"type":"null"}]},"organizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastActiveAt":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["role","status","id","name","lastName","email","emailVerified","image","phone","jobTitle","signature","signatureImageUrl","signatureDisclaimer","organizationId","createdAt","updatedAt","lastActiveAt"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}},"get":{"operationId":"user-list","description":"Lists all users of your organization","tags":["user"],"security":[{"Authorization":[]}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"role":{"anyOf":[{"type":"string","enum":["SuperAdmin","Admin","Member","Limited","ViewOnly","DistributionList"]},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["Active","Disabled","Invited"]},{"type":"null"}]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastName":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailVerified":{"anyOf":[{"type":"string"},{"type":"null"}]},"image":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"signature":{"type":"boolean"},"signatureImageUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"signatureDisclaimer":{"anyOf":[{"type":"string"},{"type":"null"}]},"organizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastActiveAt":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["role","status","id","name","lastName","email","emailVerified","image","phone","jobTitle","signature","signatureImageUrl","signatureDisclaimer","organizationId","createdAt","updatedAt","lastActiveAt"],"additionalProperties":false}}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}},"/user/search":{"post":{"operationId":"user-search","description":"Searches by name or email for users in your organization. The results are paginated with a limit of 20 entries per response.","tags":["user"],"security":[{"Authorization":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"search":{"type":"string"},"p":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["search"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"role":{"anyOf":[{"type":"string","enum":["SuperAdmin","Admin","Member","Limited","ViewOnly","DistributionList"]},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["Active","Disabled","Invited"]},{"type":"null"}]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastName":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailVerified":{"anyOf":[{"type":"string"},{"type":"null"}]},"image":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"signature":{"type":"boolean"},"signatureImageUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"signatureDisclaimer":{"anyOf":[{"type":"string"},{"type":"null"}]},"organizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastActiveAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"bpadmin":{"type":"boolean"}},"required":["role","status","id","name","lastName","email","emailVerified","image","phone","jobTitle","signature","signatureImageUrl","signatureDisclaimer","organizationId","createdAt","updatedAt","lastActiveAt","bpadmin"],"additionalProperties":false}},"next":{"type":"object","properties":{"p":{"type":"number"}},"required":["p"],"additionalProperties":false},"previous":{"type":"object","properties":{"p":{"type":"number"}},"required":["p"],"additionalProperties":false},"limit":{"type":"number"},"totalPages":{"type":"number"},"totalRecords":{"type":"number"}},"required":["results","limit","totalPages","totalRecords"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}},"/shipment/{shipmentId}/auto-schedule":{"post":{"operationId":"shipment-autoSchedule","description":"Triggers auto scheduling for that shipment. Uses Bookr rules.","tags":["shipment"],"security":[{"Authorization":[]}],"parameters":[{"in":"path","name":"shipmentId","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}},"required":["success"],"additionalProperties":false}}},"required":["result"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}},"/shipment":{"post":{"operationId":"shipment-create","description":"Creates a new shipment with at least one appointment","tags":["shipment"],"security":[{"Authorization":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"shipment":{"type":"object","properties":{"equipmentType":{"description":"The type of equipment used for the shipment.","type":"string","enum":["ET53V","ET48V","ET53R","ET48R","ET40C","ET20C","ET53F","ET48F","ETLiftGate"]},"temperature":{"description":"The trailer temperature of the shipment.","type":"string","enum":["Dry","Ambient","Fresh","Frozen","Cooler"]},"sealNumber":{"description":"The seal number of the shipment.","type":"string"},"bolNumber":{"description":"The bill of lading number of the shipment.","type":"string"},"scac":{"description":"A SCAC code override for the shipment.","type":"string"},"externalShipmentId":{"description":"The ID of the shipment in an external system (e.g. TMS).","type":"string"},"carrierLoadId":{"description":"The carrier load ID of the shipment.","type":"string"},"shipDate":{"description":"The ship date of the shipment.","type":"string","pattern":"^\\d{4}-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1])$"},"dueDate":{"description":"The due date of the shipment.","type":"string","pattern":"^\\d{4}-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1])$"},"appointments":{"minItems":1,"type":"array","items":{"type":"object","properties":{"facility":{"type":"object","properties":{"name":{"description":"The name of the facility.","type":"string","minLength":1},"street":{"description":"The street address of the facility.","type":"string","minLength":1},"suite":{"description":"The suite number of the facility.","type":"string"},"zipcode":{"description":"The zip/postal code of the facility.","type":"string","minLength":1},"city":{"description":"The city of the facility.","type":"string","minLength":1},"state":{"description":"The state of the facility.","type":"string","minLength":1},"phoneNumber":{"description":"The phone number of the facility.","type":"string"},"email":{"description":"The email of the facility.","type":"string","pattern":"^[a-zA-Z0-9._%+&'-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"},"country":{"description":"The country of the facility.","type":"string","enum":["US","MX","CA"]},"notes":{"description":"Notes about the facility.","type":"string"}},"required":["name","street","zipcode","city","state","country"]},"facilityId":{"description":"The ID of the facility this appointment belongs to.","type":"string"},"direction":{"description":"The direction of the appointment.","type":"string","enum":["Inbound","Outbound"]},"unloadingType":{"description":"The type of unloading operation.","type":"string","enum":["Live","Drop"]},"loadingType":{"description":"The type of loading method.","type":"string","enum":["Pallet","Case","Floor","SlipSheet","Bale","Corrugated","Crate","Drum","Gaylord","Roll","Skid","Other"]},"palletCount":{"description":"The number of pallets for this appointment.","anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"description":{"description":"Additional notes or description for the appointment.","type":"string"},"ftl":{"description":"Full Truck Load (FTL) indicator. When true, the appointment is for a full truck load. When false, it is Less Than Truckload (LTL). Defaults to true.","type":"boolean"},"targetDate":{"description":"The preferred or target date/time for the appointment. May be used in conjunction with targetDateEnd to specify a time range.","anyOf":[{"type":"string","pattern":"^\\d{4}-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1])$"},{"type":"string","pattern":"^\\d{4}-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1])T([0-1][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])Z$"}]},"targetDateEnd":{"description":"The end of the target date/time range. Used to specify a preferred time window. Must be greater than or equal to targetDate.","anyOf":[{"type":"string","pattern":"^\\d{4}-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1])$"},{"type":"string","pattern":"^\\d{4}-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1])T([0-1][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])Z$"}]},"trailerNumber":{"description":"The trailer number for this appointment.","type":"string"},"truckIdentifier":{"description":"An identifier for the truck.","type":"string"},"driverName":{"description":"The name of the driver for this appointment.","type":"string"},"driverPhone":{"description":"The phone number of the driver for this appointment.","type":"string"},"wmsNumber":{"description":"Warehouse Management System (WMS) number. This field is only used for Warehouse organization types.","type":"string"},"orderNumber":{"description":"Order number of the appointment (PU / DEL number). This is the primary field for appointment identification.","type":"string"},"referenceNumber":{"description":"Reference number for the appointment.","type":"string"},"duration":{"description":"The duration of the appointment in minutes.","type":"integer","minimum":0,"maximum":9007199254740991},"lumper":{"description":"Whether the appointment is a lumper appointment. Also known as \"Driver Assistance Requested\" or \"Hand Bombing Requested.\"","type":"boolean"},"status":{"description":"The status of the appointment. Defaults to \"Draft\". Use \"NotApplicable\" to build a full shipment but ignore the appointment during scheduling.","type":"string","enum":["Draft","NotApplicable"]},"originSourceId":{"description":"An optional ID, use this field to store your internal system stop id for future reference","anyOf":[{"type":"string"},{"type":"null"}]},"purchaseOrders":{}},"required":["direction","unloadingType","purchaseOrders"],"additionalProperties":false}},"customerId":{"description":"The ID of the customer organization (also known as the shipper) - the organization shipping the goods.","type":"string"},"customerIrc":{"description":"The IRC code of the customer.","type":"string"},"carrierId":{"description":"The ID of the carrier organization.","type":"string"},"distanceOverride":{"description":"A manual distance override for the shipment, to be used instead of the calculated distance.","type":"integer","minimum":0,"maximum":9007199254740991},"purchaseOrders":{"type":"array","items":{"type":"object","properties":{"poNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"handlingType":{"anyOf":[{"type":"string","enum":["Pallet","Case","Floor","SlipSheet","Bale","Corrugated","Crate","Drum","Gaylord","Roll","Skid","Other"]},{"type":"null"}]},"handlingQuantity":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"packingType":{"anyOf":[{"type":"string","enum":["Case","Carton","Box","Bag","Drum","Bundle","Piece","Other"]},{"type":"null"}]},"packingQuantity":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"weightLbs":{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string"},{"type":"object","properties":{"d":{"type":"array","items":{"type":"number"}},"e":{"type":"number"},"s":{"type":"number"},"toFixed":{}},"required":["d","e","s","toFixed"]}]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"loadingAppointmentNumber":{"description":"The stop number in sequence where this PO is loaded. Starts at 1.","anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"unloadingAppointmentNumber":{"description":"The stop number in sequence where this PO is unloaded. Starts at 1.","anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}}}},"originSourceId":{"description":"An optional ID, use this field to store your internal system shipment id for future reference","anyOf":[{"type":"string"},{"type":"null"}]},"externalId":{"description":"The ID of the shipment in an external system (e.g. TMS). This field is deprecated and will be removed in a future version.","anyOf":[{"type":"string"},{"type":"null"}]},"customerName":{"description":"The name of the customer organization (also known as the shipper).","type":"string"}},"required":["appointments"],"additionalProperties":false}},"required":["shipment"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"equipmentType":{"anyOf":[{"type":"string","enum":["ET53V","ET48V","ET53R","ET48R","ET40C","ET20C","ET53F","ET48F","ETLiftGate"]},{"type":"null"}]},"temperature":{"anyOf":[{"type":"string","enum":["Dry","Ambient","Fresh","Frozen","Cooler"]},{"type":"null"}]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"organizationId":{"type":"string"},"customerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"carrierId":{"anyOf":[{"type":"string"},{"type":"null"}]},"sealNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"bolNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"carrierLoadId":{"anyOf":[{"type":"string"},{"type":"null"}]},"scac":{"anyOf":[{"type":"string"},{"type":"null"}]},"distance":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"distanceOverride":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"shipDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"dueDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"externalShipmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"isInfeasible":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"isInfeasibleNotified":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"originSourceId":{"anyOf":[{"type":"string"},{"type":"null"}]},"appointments":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["Started","Unscheduled","Draft","Pending","Scheduled","CheckedIn","AtDock","DroppedOff","ReadyForPickup","Canceled","Completed","Declined","Refused","OnHold","Expired","Rescheduled","NotApplicable"]},"unloadingType":{"type":"string","enum":["Live","Drop"]},"loadingType":{"anyOf":[{"type":"string","enum":["Pallet","Case","Floor","SlipSheet","Bale","Corrugated","Crate","Drum","Gaylord","Roll","Skid","Other"]},{"type":"null"}]},"complianceStatus":{"anyOf":[{"type":"string","enum":["OnTime","Late","Unplanned","Early","NoShow","LateWorkIn"]},{"type":"null"}]},"direction":{"type":"string","enum":["Inbound","Outbound"]},"priority":{"type":"string","enum":["High","Medium","None"]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"date":{"type":"string"},"dateTz":{"anyOf":[{"type":"string"},{"type":"null"}]},"detention":{"type":"boolean"},"ftl":{"type":"boolean"},"duration":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"palletCount":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"rejectionReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"dueDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"targetDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"targetDateEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"overflow":{"type":"boolean"},"requestedDateEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"stopNumber":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"scheduledTimeRangeEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"timeNotNeeded":{"type":"boolean"},"dateEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"externalId":{"anyOf":[{"type":"string"},{"type":"null"}]},"confirmationNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"originSourceId":{"anyOf":[{"type":"string"},{"type":"null"}]},"lumper":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"facilityId":{"type":"string"},"dockId":{"anyOf":[{"type":"string"},{"type":"null"}]},"dropLocationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"holdingOrganizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"organizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"rescheduledByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdByUserId":{"type":"string"},"sentByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"proposedByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"parentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"trailerNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"truckIdentifier":{"anyOf":[{"type":"string"},{"type":"null"}]},"driverName":{"anyOf":[{"type":"string"},{"type":"null"}]},"driverPhone":{"anyOf":[{"type":"string"},{"type":"null"}]},"selfCheckedIn":{"type":"boolean"},"scheduledAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"checkedInAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"atDockAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"droppedOffAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"readyForPickupAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastRequestSentAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"firstScheduledAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"arrivedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"departedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"shipmentId":{"type":"string"},"wmsNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"orderNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"referenceNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"resentCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"recurringAppointmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"schedulingMethodId":{"anyOf":[{"type":"string"},{"type":"null"}]},"rescheduleCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"facility":{"type":"object","properties":{"status":{"type":"string","enum":["Operational","ClosedTemporarily","ClosedPermanently"]},"type":{"type":"string","enum":["Verified","External","Internal"]},"country":{"type":"string","enum":["US","MX","CA"]},"schedulingType":{"anyOf":[{"type":"string","enum":["Appointment","FirstComeFirstServe"]},{"type":"null"}]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"name":{"type":"string"},"phoneNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"irc":{"anyOf":[{"type":"string"},{"type":"null"}]},"deleted":{"anyOf":[{"type":"string"},{"type":"null"}]},"street":{"type":"string"},"suite":{"anyOf":[{"type":"string"},{"type":"null"}]},"zipcode":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"latitude":{"type":"string"},"longitude":{"type":"string"},"timeZone":{"type":"string"},"deprecated":{"type":"boolean"},"organizationId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"amenities":{"anyOf":[{"type":"string"},{"type":"null"}]},"cutOffTime":{"type":"string"},"schedulingDaysAheadMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"schedulingDaysAheadMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"allowSameDayReschedule":{"type":"boolean"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"selfCheckIn":{"type":"boolean"},"placeKeyId":{"anyOf":[{"type":"string"},{"type":"null"}]},"requiredFields":{"anyOf":[{"$ref":"#/components/schemas/__schema1"},{"type":"null"}]},"thirdPartyId":{"anyOf":[{"type":"string"},{"type":"null"}]},"originalId":{"anyOf":[{"type":"string"},{"type":"null"}]},"autoConfirmAppointments":{"type":"boolean"},"reasonCodesEnabled":{"type":"boolean"}},"required":["status","type","country","schedulingType","id","name","phoneNumber","email","irc","deleted","street","suite","zipcode","city","state","latitude","longitude","timeZone","deprecated","organizationId","createdAt","updatedAt","amenities","cutOffTime","schedulingDaysAheadMin","schedulingDaysAheadMax","allowSameDayReschedule","notes","selfCheckIn","placeKeyId","requiredFields","thirdPartyId","originalId","autoConfirmAppointments","reasonCodesEnabled"],"additionalProperties":false},"hasSchedulingMethod":{"description":"Whether the organization that created the appointment has a scheduling method defined for the appointment facility","type":"boolean"}},"required":["status","unloadingType","loadingType","complianceStatus","direction","priority","id","date","dateTz","detention","ftl","duration","palletCount","description","rejectionReason","dueDate","targetDate","targetDateEnd","overflow","requestedDateEnd","stopNumber","scheduledTimeRangeEnd","timeNotNeeded","dateEnd","externalId","confirmationNumber","originSourceId","lumper","facilityId","dockId","dropLocationId","holdingOrganizationId","organizationId","rescheduledByUserId","createdByUserId","sentByUserId","proposedByUserId","parentId","trailerNumber","truckIdentifier","driverName","driverPhone","selfCheckedIn","scheduledAt","checkedInAt","atDockAt","droppedOffAt","readyForPickupAt","completedAt","createdAt","updatedAt","lastRequestSentAt","firstScheduledAt","arrivedAt","departedAt","shipmentId","wmsNumber","orderNumber","referenceNumber","resentCount","recurringAppointmentId","schedulingMethodId","rescheduleCount","facility","hasSchedulingMethod"],"additionalProperties":false}}},"required":["equipmentType","temperature","id","createdAt","updatedAt","organizationId","customerId","carrierId","sealNumber","bolNumber","carrierLoadId","scac","distance","distanceOverride","shipDate","dueDate","externalShipmentId","isInfeasible","isInfeasibleNotified","originSourceId","appointments"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}},"/shipment/{shipmentId}":{"get":{"operationId":"shipment-get","description":"Retrieves a given shipment with all its appointments","tags":["shipment"],"security":[{"Authorization":[]}],"parameters":[{"in":"path","name":"shipmentId","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"equipmentType":{"anyOf":[{"type":"string","enum":["ET53V","ET48V","ET53R","ET48R","ET40C","ET20C","ET53F","ET48F","ETLiftGate"]},{"type":"null"}]},"temperature":{"anyOf":[{"type":"string","enum":["Dry","Ambient","Fresh","Frozen","Cooler"]},{"type":"null"}]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"organizationId":{"type":"string"},"customerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"carrierId":{"anyOf":[{"type":"string"},{"type":"null"}]},"sealNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"bolNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"carrierLoadId":{"anyOf":[{"type":"string"},{"type":"null"}]},"scac":{"anyOf":[{"type":"string"},{"type":"null"}]},"distance":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"distanceOverride":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"shipDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"dueDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"externalShipmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"isInfeasible":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"isInfeasibleNotified":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"originSourceId":{"anyOf":[{"type":"string"},{"type":"null"}]},"appointments":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["Started","Unscheduled","Draft","Pending","Scheduled","CheckedIn","AtDock","DroppedOff","ReadyForPickup","Canceled","Completed","Declined","Refused","OnHold","Expired","Rescheduled","NotApplicable"]},"unloadingType":{"type":"string","enum":["Live","Drop"]},"loadingType":{"anyOf":[{"type":"string","enum":["Pallet","Case","Floor","SlipSheet","Bale","Corrugated","Crate","Drum","Gaylord","Roll","Skid","Other"]},{"type":"null"}]},"complianceStatus":{"anyOf":[{"type":"string","enum":["OnTime","Late","Unplanned","Early","NoShow","LateWorkIn"]},{"type":"null"}]},"direction":{"type":"string","enum":["Inbound","Outbound"]},"priority":{"type":"string","enum":["High","Medium","None"]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"date":{"type":"string"},"dateTz":{"anyOf":[{"type":"string"},{"type":"null"}]},"detention":{"type":"boolean"},"ftl":{"type":"boolean"},"duration":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"palletCount":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"rejectionReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"dueDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"targetDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"targetDateEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"overflow":{"type":"boolean"},"requestedDateEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"stopNumber":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"scheduledTimeRangeEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"timeNotNeeded":{"type":"boolean"},"dateEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"externalId":{"anyOf":[{"type":"string"},{"type":"null"}]},"confirmationNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"originSourceId":{"anyOf":[{"type":"string"},{"type":"null"}]},"lumper":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"facilityId":{"type":"string"},"dockId":{"anyOf":[{"type":"string"},{"type":"null"}]},"dropLocationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"holdingOrganizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"organizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"rescheduledByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdByUserId":{"type":"string"},"sentByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"proposedByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"parentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"trailerNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"truckIdentifier":{"anyOf":[{"type":"string"},{"type":"null"}]},"driverName":{"anyOf":[{"type":"string"},{"type":"null"}]},"driverPhone":{"anyOf":[{"type":"string"},{"type":"null"}]},"selfCheckedIn":{"type":"boolean"},"scheduledAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"checkedInAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"atDockAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"droppedOffAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"readyForPickupAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastRequestSentAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"firstScheduledAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"arrivedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"departedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"shipmentId":{"type":"string"},"wmsNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"orderNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"referenceNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"resentCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"recurringAppointmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"schedulingMethodId":{"anyOf":[{"type":"string"},{"type":"null"}]},"rescheduleCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"facility":{"type":"object","properties":{"status":{"type":"string","enum":["Operational","ClosedTemporarily","ClosedPermanently"]},"type":{"type":"string","enum":["Verified","External","Internal"]},"country":{"type":"string","enum":["US","MX","CA"]},"schedulingType":{"anyOf":[{"type":"string","enum":["Appointment","FirstComeFirstServe"]},{"type":"null"}]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"name":{"type":"string"},"phoneNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"irc":{"anyOf":[{"type":"string"},{"type":"null"}]},"deleted":{"anyOf":[{"type":"string"},{"type":"null"}]},"street":{"type":"string"},"suite":{"anyOf":[{"type":"string"},{"type":"null"}]},"zipcode":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"latitude":{"type":"string"},"longitude":{"type":"string"},"timeZone":{"type":"string"},"deprecated":{"type":"boolean"},"organizationId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"amenities":{"anyOf":[{"type":"string"},{"type":"null"}]},"cutOffTime":{"type":"string"},"schedulingDaysAheadMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"schedulingDaysAheadMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"allowSameDayReschedule":{"type":"boolean"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"selfCheckIn":{"type":"boolean"},"placeKeyId":{"anyOf":[{"type":"string"},{"type":"null"}]},"requiredFields":{"anyOf":[{"$ref":"#/components/schemas/__schema1"},{"type":"null"}]},"thirdPartyId":{"anyOf":[{"type":"string"},{"type":"null"}]},"originalId":{"anyOf":[{"type":"string"},{"type":"null"}]},"autoConfirmAppointments":{"type":"boolean"},"reasonCodesEnabled":{"type":"boolean"}},"required":["status","type","country","schedulingType","id","name","phoneNumber","email","irc","deleted","street","suite","zipcode","city","state","latitude","longitude","timeZone","deprecated","organizationId","createdAt","updatedAt","amenities","cutOffTime","schedulingDaysAheadMin","schedulingDaysAheadMax","allowSameDayReschedule","notes","selfCheckIn","placeKeyId","requiredFields","thirdPartyId","originalId","autoConfirmAppointments","reasonCodesEnabled"],"additionalProperties":false}},"required":["status","unloadingType","loadingType","complianceStatus","direction","priority","id","date","dateTz","detention","ftl","duration","palletCount","description","rejectionReason","dueDate","targetDate","targetDateEnd","overflow","requestedDateEnd","stopNumber","scheduledTimeRangeEnd","timeNotNeeded","dateEnd","externalId","confirmationNumber","originSourceId","lumper","facilityId","dockId","dropLocationId","holdingOrganizationId","organizationId","rescheduledByUserId","createdByUserId","sentByUserId","proposedByUserId","parentId","trailerNumber","truckIdentifier","driverName","driverPhone","selfCheckedIn","scheduledAt","checkedInAt","atDockAt","droppedOffAt","readyForPickupAt","completedAt","createdAt","updatedAt","lastRequestSentAt","firstScheduledAt","arrivedAt","departedAt","shipmentId","wmsNumber","orderNumber","referenceNumber","resentCount","recurringAppointmentId","schedulingMethodId","rescheduleCount","facility"],"additionalProperties":false}}},"required":["equipmentType","temperature","id","createdAt","updatedAt","organizationId","customerId","carrierId","sealNumber","bolNumber","carrierLoadId","scac","distance","distanceOverride","shipDate","dueDate","externalShipmentId","isInfeasible","isInfeasibleNotified","originSourceId","appointments"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.NOT_FOUND"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}},"/shipment/search":{"post":{"operationId":"shipment-search","description":"Searches orders by any reference number (BOL, WMS, etc.). The results are paginated with a limit of 20 entries per response.","tags":["shipment"],"security":[{"Authorization":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"search":{"type":"string"},"p":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["search"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"equipmentType":{"anyOf":[{"type":"string","enum":["ET53V","ET48V","ET53R","ET48R","ET40C","ET20C","ET53F","ET48F","ETLiftGate"]},{"type":"null"}]},"temperature":{"anyOf":[{"type":"string","enum":["Dry","Ambient","Fresh","Frozen","Cooler"]},{"type":"null"}]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"organizationId":{"type":"string"},"customerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"carrierId":{"anyOf":[{"type":"string"},{"type":"null"}]},"sealNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"bolNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"carrierLoadId":{"anyOf":[{"type":"string"},{"type":"null"}]},"scac":{"anyOf":[{"type":"string"},{"type":"null"}]},"distance":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"distanceOverride":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"shipDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"dueDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"externalShipmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"isInfeasible":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"isInfeasibleNotified":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"originSourceId":{"anyOf":[{"type":"string"},{"type":"null"}]},"appointments":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["Started","Unscheduled","Draft","Pending","Scheduled","CheckedIn","AtDock","DroppedOff","ReadyForPickup","Canceled","Completed","Declined","Refused","OnHold","Expired","Rescheduled","NotApplicable"]},"unloadingType":{"type":"string","enum":["Live","Drop"]},"loadingType":{"anyOf":[{"type":"string","enum":["Pallet","Case","Floor","SlipSheet","Bale","Corrugated","Crate","Drum","Gaylord","Roll","Skid","Other"]},{"type":"null"}]},"complianceStatus":{"anyOf":[{"type":"string","enum":["OnTime","Late","Unplanned","Early","NoShow","LateWorkIn"]},{"type":"null"}]},"direction":{"type":"string","enum":["Inbound","Outbound"]},"priority":{"type":"string","enum":["High","Medium","None"]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"date":{"type":"string"},"dateTz":{"anyOf":[{"type":"string"},{"type":"null"}]},"detention":{"type":"boolean"},"ftl":{"type":"boolean"},"duration":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"palletCount":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"rejectionReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"dueDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"targetDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"targetDateEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"overflow":{"type":"boolean"},"requestedDateEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"stopNumber":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"scheduledTimeRangeEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"timeNotNeeded":{"type":"boolean"},"dateEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"externalId":{"anyOf":[{"type":"string"},{"type":"null"}]},"confirmationNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"originSourceId":{"anyOf":[{"type":"string"},{"type":"null"}]},"lumper":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"facilityId":{"type":"string"},"dockId":{"anyOf":[{"type":"string"},{"type":"null"}]},"dropLocationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"holdingOrganizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"organizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"rescheduledByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdByUserId":{"type":"string"},"sentByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"proposedByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"parentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"trailerNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"truckIdentifier":{"anyOf":[{"type":"string"},{"type":"null"}]},"driverName":{"anyOf":[{"type":"string"},{"type":"null"}]},"driverPhone":{"anyOf":[{"type":"string"},{"type":"null"}]},"selfCheckedIn":{"type":"boolean"},"scheduledAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"checkedInAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"atDockAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"droppedOffAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"readyForPickupAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastRequestSentAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"firstScheduledAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"arrivedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"departedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"shipmentId":{"type":"string"},"wmsNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"orderNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"referenceNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"resentCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"recurringAppointmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"schedulingMethodId":{"anyOf":[{"type":"string"},{"type":"null"}]},"rescheduleCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["status","unloadingType","loadingType","complianceStatus","direction","priority","id","date","dateTz","detention","ftl","duration","palletCount","description","rejectionReason","dueDate","targetDate","targetDateEnd","overflow","requestedDateEnd","stopNumber","scheduledTimeRangeEnd","timeNotNeeded","dateEnd","externalId","confirmationNumber","originSourceId","lumper","facilityId","dockId","dropLocationId","holdingOrganizationId","organizationId","rescheduledByUserId","createdByUserId","sentByUserId","proposedByUserId","parentId","trailerNumber","truckIdentifier","driverName","driverPhone","selfCheckedIn","scheduledAt","checkedInAt","atDockAt","droppedOffAt","readyForPickupAt","completedAt","createdAt","updatedAt","lastRequestSentAt","firstScheduledAt","arrivedAt","departedAt","shipmentId","wmsNumber","orderNumber","referenceNumber","resentCount","recurringAppointmentId","schedulingMethodId","rescheduleCount"],"additionalProperties":false}}},"required":["equipmentType","temperature","id","createdAt","updatedAt","organizationId","customerId","carrierId","sealNumber","bolNumber","carrierLoadId","scac","distance","distanceOverride","shipDate","dueDate","externalShipmentId","isInfeasible","isInfeasibleNotified","originSourceId","appointments"],"additionalProperties":false}},"next":{"type":"object","properties":{"p":{"type":"number"}},"required":["p"],"additionalProperties":false},"previous":{"type":"object","properties":{"p":{"type":"number"}},"required":["p"],"additionalProperties":false},"limit":{"type":"number"},"totalPages":{"type":"number"},"totalRecords":{"type":"number"}},"required":["results","limit","totalPages","totalRecords"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}},"/shipment/{id}":{"patch":{"operationId":"shipment-update","description":"Updates an existing shipment that your organization created","tags":["shipment"],"security":[{"Authorization":[]}],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"equipmentType":{"description":"The type of equipment used for the shipment.","type":"string","enum":["ET53V","ET48V","ET53R","ET48R","ET40C","ET20C","ET53F","ET48F","ETLiftGate"]},"temperature":{"description":"The trailer temperature of the shipment.","type":"string","enum":["Dry","Ambient","Fresh","Frozen","Cooler"]},"sealNumber":{"description":"The seal number of the shipment.","type":"string"},"bolNumber":{"description":"The bill of lading number of the shipment.","type":"string"},"scac":{"description":"A SCAC code override for the shipment.","type":"string"},"externalShipmentId":{"description":"The ID of the shipment in an external system (e.g. TMS).","type":"string"},"carrierLoadId":{"description":"The carrier load ID of the shipment.","type":"string"},"shipDate":{"description":"The ship date of the shipment.","type":"string","pattern":"^\\d{4}-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1])$"},"dueDate":{"description":"The due date of the shipment.","type":"string","pattern":"^\\d{4}-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1])$"},"appointments":{"not":{}},"customerId":{"description":"The ID of the customer organization (also known as the shipper) - the organization shipping the goods.","type":"string"},"customerIrc":{"description":"The IRC code of the customer.","type":"string"},"carrierId":{"description":"The ID of the carrier organization.","type":"string"},"distanceOverride":{"description":"A manual distance override for the shipment, to be used instead of the calculated distance.","type":"integer","minimum":0,"maximum":9007199254740991},"purchaseOrders":{"type":"array","items":{"type":"object","properties":{"poNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"handlingType":{"anyOf":[{"type":"string","enum":["Pallet","Case","Floor","SlipSheet","Bale","Corrugated","Crate","Drum","Gaylord","Roll","Skid","Other"]},{"type":"null"}]},"handlingQuantity":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"packingType":{"anyOf":[{"type":"string","enum":["Case","Carton","Box","Bag","Drum","Bundle","Piece","Other"]},{"type":"null"}]},"packingQuantity":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"weightLbs":{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string"},{"type":"object","properties":{"d":{"type":"array","items":{"type":"number"}},"e":{"type":"number"},"s":{"type":"number"},"toFixed":{}},"required":["d","e","s","toFixed"]}]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"loadingAppointmentNumber":{"description":"The stop number in sequence where this PO is loaded. Starts at 1.","anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"unloadingAppointmentNumber":{"description":"The stop number in sequence where this PO is unloaded. Starts at 1.","anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}}}},"originSourceId":{"description":"An optional ID, use this field to store your internal system shipment id for future reference","anyOf":[{"type":"string"},{"type":"null"}]},"externalId":{"description":"The ID of the shipment in an external system (e.g. TMS). This field is deprecated and will be removed in a future version.","anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"equipmentType":{"anyOf":[{"type":"string","enum":["ET53V","ET48V","ET53R","ET48R","ET40C","ET20C","ET53F","ET48F","ETLiftGate"]},{"type":"null"}]},"temperature":{"anyOf":[{"type":"string","enum":["Dry","Ambient","Fresh","Frozen","Cooler"]},{"type":"null"}]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"organizationId":{"type":"string"},"customerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"carrierId":{"anyOf":[{"type":"string"},{"type":"null"}]},"sealNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"bolNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"carrierLoadId":{"anyOf":[{"type":"string"},{"type":"null"}]},"scac":{"anyOf":[{"type":"string"},{"type":"null"}]},"distance":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"distanceOverride":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"shipDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"dueDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"externalShipmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"isInfeasible":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"isInfeasibleNotified":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"originSourceId":{"anyOf":[{"type":"string"},{"type":"null"}]},"appointments":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["Started","Unscheduled","Draft","Pending","Scheduled","CheckedIn","AtDock","DroppedOff","ReadyForPickup","Canceled","Completed","Declined","Refused","OnHold","Expired","Rescheduled","NotApplicable"]},"unloadingType":{"type":"string","enum":["Live","Drop"]},"loadingType":{"anyOf":[{"type":"string","enum":["Pallet","Case","Floor","SlipSheet","Bale","Corrugated","Crate","Drum","Gaylord","Roll","Skid","Other"]},{"type":"null"}]},"complianceStatus":{"anyOf":[{"type":"string","enum":["OnTime","Late","Unplanned","Early","NoShow","LateWorkIn"]},{"type":"null"}]},"direction":{"type":"string","enum":["Inbound","Outbound"]},"priority":{"type":"string","enum":["High","Medium","None"]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"date":{"type":"string"},"dateTz":{"anyOf":[{"type":"string"},{"type":"null"}]},"detention":{"type":"boolean"},"ftl":{"type":"boolean"},"duration":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"palletCount":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"rejectionReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"dueDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"targetDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"targetDateEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"overflow":{"type":"boolean"},"requestedDateEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"stopNumber":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"scheduledTimeRangeEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"timeNotNeeded":{"type":"boolean"},"dateEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"externalId":{"anyOf":[{"type":"string"},{"type":"null"}]},"confirmationNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"originSourceId":{"anyOf":[{"type":"string"},{"type":"null"}]},"lumper":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"facilityId":{"type":"string"},"dockId":{"anyOf":[{"type":"string"},{"type":"null"}]},"dropLocationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"holdingOrganizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"organizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"rescheduledByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdByUserId":{"type":"string"},"sentByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"proposedByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"parentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"trailerNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"truckIdentifier":{"anyOf":[{"type":"string"},{"type":"null"}]},"driverName":{"anyOf":[{"type":"string"},{"type":"null"}]},"driverPhone":{"anyOf":[{"type":"string"},{"type":"null"}]},"selfCheckedIn":{"type":"boolean"},"scheduledAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"checkedInAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"atDockAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"droppedOffAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"readyForPickupAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastRequestSentAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"firstScheduledAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"arrivedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"departedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"shipmentId":{"type":"string"},"wmsNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"orderNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"referenceNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"resentCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"recurringAppointmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"schedulingMethodId":{"anyOf":[{"type":"string"},{"type":"null"}]},"rescheduleCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"facility":{"type":"object","properties":{"status":{"type":"string","enum":["Operational","ClosedTemporarily","ClosedPermanently"]},"type":{"type":"string","enum":["Verified","External","Internal"]},"country":{"type":"string","enum":["US","MX","CA"]},"schedulingType":{"anyOf":[{"type":"string","enum":["Appointment","FirstComeFirstServe"]},{"type":"null"}]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"name":{"type":"string"},"phoneNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"irc":{"anyOf":[{"type":"string"},{"type":"null"}]},"deleted":{"anyOf":[{"type":"string"},{"type":"null"}]},"street":{"type":"string"},"suite":{"anyOf":[{"type":"string"},{"type":"null"}]},"zipcode":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"latitude":{"type":"string"},"longitude":{"type":"string"},"timeZone":{"type":"string"},"deprecated":{"type":"boolean"},"organizationId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"amenities":{"anyOf":[{"type":"string"},{"type":"null"}]},"cutOffTime":{"type":"string"},"schedulingDaysAheadMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"schedulingDaysAheadMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"allowSameDayReschedule":{"type":"boolean"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"selfCheckIn":{"type":"boolean"},"placeKeyId":{"anyOf":[{"type":"string"},{"type":"null"}]},"requiredFields":{"anyOf":[{"$ref":"#/components/schemas/__schema1"},{"type":"null"}]},"thirdPartyId":{"anyOf":[{"type":"string"},{"type":"null"}]},"originalId":{"anyOf":[{"type":"string"},{"type":"null"}]},"autoConfirmAppointments":{"type":"boolean"},"reasonCodesEnabled":{"type":"boolean"}},"required":["status","type","country","schedulingType","id","name","phoneNumber","email","irc","deleted","street","suite","zipcode","city","state","latitude","longitude","timeZone","deprecated","organizationId","createdAt","updatedAt","amenities","cutOffTime","schedulingDaysAheadMin","schedulingDaysAheadMax","allowSameDayReschedule","notes","selfCheckIn","placeKeyId","requiredFields","thirdPartyId","originalId","autoConfirmAppointments","reasonCodesEnabled"],"additionalProperties":false}},"required":["status","unloadingType","loadingType","complianceStatus","direction","priority","id","date","dateTz","detention","ftl","duration","palletCount","description","rejectionReason","dueDate","targetDate","targetDateEnd","overflow","requestedDateEnd","stopNumber","scheduledTimeRangeEnd","timeNotNeeded","dateEnd","externalId","confirmationNumber","originSourceId","lumper","facilityId","dockId","dropLocationId","holdingOrganizationId","organizationId","rescheduledByUserId","createdByUserId","sentByUserId","proposedByUserId","parentId","trailerNumber","truckIdentifier","driverName","driverPhone","selfCheckedIn","scheduledAt","checkedInAt","atDockAt","droppedOffAt","readyForPickupAt","completedAt","createdAt","updatedAt","lastRequestSentAt","firstScheduledAt","arrivedAt","departedAt","shipmentId","wmsNumber","orderNumber","referenceNumber","resentCount","recurringAppointmentId","schedulingMethodId","rescheduleCount","facility"],"additionalProperties":false}}},"required":["equipmentType","temperature","id","createdAt","updatedAt","organizationId","customerId","carrierId","sealNumber","bolNumber","carrierLoadId","scac","distance","distanceOverride","shipDate","dueDate","externalShipmentId","isInfeasible","isInfeasibleNotified","originSourceId","appointments"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.NOT_FOUND"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}},"/appointment/{appointmentId}":{"get":{"operationId":"appointment-get","description":"Retrieves a given appointment","tags":["appointment"],"security":[{"Authorization":[]}],"parameters":[{"in":"path","name":"appointmentId","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["Started","Unscheduled","Draft","Pending","Scheduled","CheckedIn","AtDock","DroppedOff","ReadyForPickup","Canceled","Completed","Declined","Refused","OnHold","Expired","Rescheduled","NotApplicable"]},"unloadingType":{"type":"string","enum":["Live","Drop"]},"loadingType":{"anyOf":[{"type":"string","enum":["Pallet","Case","Floor","SlipSheet","Bale","Corrugated","Crate","Drum","Gaylord","Roll","Skid","Other"]},{"type":"null"}]},"complianceStatus":{"anyOf":[{"type":"string","enum":["OnTime","Late","Unplanned","Early","NoShow","LateWorkIn"]},{"type":"null"}]},"direction":{"type":"string","enum":["Inbound","Outbound"]},"priority":{"type":"string","enum":["High","Medium","None"]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"date":{"type":"string"},"dateTz":{"anyOf":[{"type":"string"},{"type":"null"}]},"detention":{"type":"boolean"},"ftl":{"type":"boolean"},"duration":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"palletCount":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"rejectionReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"dueDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"targetDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"targetDateEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"overflow":{"type":"boolean"},"requestedDateEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"stopNumber":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"scheduledTimeRangeEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"timeNotNeeded":{"type":"boolean"},"dateEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"externalId":{"anyOf":[{"type":"string"},{"type":"null"}]},"confirmationNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"originSourceId":{"anyOf":[{"type":"string"},{"type":"null"}]},"lumper":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"facilityId":{"type":"string"},"dockId":{"anyOf":[{"type":"string"},{"type":"null"}]},"dropLocationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"holdingOrganizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"organizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"rescheduledByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdByUserId":{"type":"string"},"sentByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"proposedByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"parentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"trailerNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"truckIdentifier":{"anyOf":[{"type":"string"},{"type":"null"}]},"driverName":{"anyOf":[{"type":"string"},{"type":"null"}]},"driverPhone":{"anyOf":[{"type":"string"},{"type":"null"}]},"selfCheckedIn":{"type":"boolean"},"scheduledAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"checkedInAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"atDockAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"droppedOffAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"readyForPickupAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastRequestSentAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"firstScheduledAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"arrivedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"departedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"shipmentId":{"type":"string"},"wmsNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"orderNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"referenceNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"resentCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"recurringAppointmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"schedulingMethodId":{"anyOf":[{"type":"string"},{"type":"null"}]},"rescheduleCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["status","unloadingType","loadingType","complianceStatus","direction","priority","id","date","dateTz","detention","ftl","duration","palletCount","description","rejectionReason","dueDate","targetDate","targetDateEnd","overflow","requestedDateEnd","stopNumber","scheduledTimeRangeEnd","timeNotNeeded","dateEnd","externalId","confirmationNumber","originSourceId","lumper","facilityId","dockId","dropLocationId","holdingOrganizationId","organizationId","rescheduledByUserId","createdByUserId","sentByUserId","proposedByUserId","parentId","trailerNumber","truckIdentifier","driverName","driverPhone","selfCheckedIn","scheduledAt","checkedInAt","atDockAt","droppedOffAt","readyForPickupAt","completedAt","createdAt","updatedAt","lastRequestSentAt","firstScheduledAt","arrivedAt","departedAt","shipmentId","wmsNumber","orderNumber","referenceNumber","resentCount","recurringAppointmentId","schedulingMethodId","rescheduleCount"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.NOT_FOUND"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}},"patch":{"operationId":"appointment-update","description":"Updates an existing appointment associated with your organization","tags":["appointment"],"security":[{"Authorization":[]}],"parameters":[{"in":"path","name":"appointmentId","schema":{"type":"string"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"direction":{"description":"The direction of the appointment.","type":"string","enum":["Inbound","Outbound"]},"unloadingType":{"description":"The type of unloading operation.","type":"string","enum":["Live","Drop"]},"loadingType":{"description":"The type of loading method.","type":"string","enum":["Pallet","Case","Floor","SlipSheet","Bale","Corrugated","Crate","Drum","Gaylord","Roll","Skid","Other"]},"palletCount":{"description":"The number of pallets for this appointment.","anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"description":{"description":"Additional notes or description for the appointment.","type":"string"},"ftl":{"description":"Full Truck Load (FTL) indicator. When true, the appointment is for a full truck load. When false, it is Less Than Truckload (LTL). Defaults to true.","type":"boolean"},"targetDate":{"description":"The preferred or target date/time for the appointment. May be used in conjunction with targetDateEnd to specify a time range.","anyOf":[{"type":"string","pattern":"^\\d{4}-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1])$"},{"type":"string","pattern":"^\\d{4}-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1])T([0-1][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])Z$"}]},"targetDateEnd":{"description":"The end of the target date/time range. Used to specify a preferred time window. Must be greater than or equal to targetDate.","anyOf":[{"type":"string","pattern":"^\\d{4}-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1])$"},{"type":"string","pattern":"^\\d{4}-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1])T([0-1][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])Z$"}]},"trailerNumber":{"description":"The trailer number for this appointment.","type":"string"},"truckIdentifier":{"description":"An identifier for the truck.","type":"string"},"driverName":{"description":"The name of the driver for this appointment.","type":"string"},"driverPhone":{"description":"The phone number of the driver for this appointment.","type":"string"},"wmsNumber":{"description":"Warehouse Management System (WMS) number. This field is only used for Warehouse organization types.","type":"string"},"orderNumber":{"description":"Order number of the appointment (PU / DEL number). This is the primary field for appointment identification.","type":"string"},"referenceNumber":{"description":"Reference number for the appointment.","type":"string"},"duration":{"description":"The duration of the appointment in minutes.","type":"integer","minimum":0,"maximum":9007199254740991},"lumper":{"description":"Whether the appointment is a lumper appointment. Also known as \"Driver Assistance Requested\" or \"Hand Bombing Requested.\"","type":"boolean"},"status":{"description":"The status of the appointment. Defaults to \"Draft\". Use \"NotApplicable\" to build a full shipment but ignore the appointment during scheduling.","type":"string","enum":["Draft","NotApplicable"]},"originSourceId":{"description":"An optional ID, use this field to store your internal system stop id for future reference","anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["Started","Unscheduled","Draft","Pending","Scheduled","CheckedIn","AtDock","DroppedOff","ReadyForPickup","Canceled","Completed","Declined","Refused","OnHold","Expired","Rescheduled","NotApplicable"]},"unloadingType":{"type":"string","enum":["Live","Drop"]},"loadingType":{"anyOf":[{"type":"string","enum":["Pallet","Case","Floor","SlipSheet","Bale","Corrugated","Crate","Drum","Gaylord","Roll","Skid","Other"]},{"type":"null"}]},"complianceStatus":{"anyOf":[{"type":"string","enum":["OnTime","Late","Unplanned","Early","NoShow","LateWorkIn"]},{"type":"null"}]},"direction":{"type":"string","enum":["Inbound","Outbound"]},"priority":{"type":"string","enum":["High","Medium","None"]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"date":{"type":"string"},"dateTz":{"anyOf":[{"type":"string"},{"type":"null"}]},"detention":{"type":"boolean"},"ftl":{"type":"boolean"},"duration":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"palletCount":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"rejectionReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"dueDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"targetDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"targetDateEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"overflow":{"type":"boolean"},"requestedDateEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"stopNumber":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"scheduledTimeRangeEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"timeNotNeeded":{"type":"boolean"},"dateEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"externalId":{"anyOf":[{"type":"string"},{"type":"null"}]},"confirmationNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"originSourceId":{"anyOf":[{"type":"string"},{"type":"null"}]},"lumper":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"facilityId":{"type":"string"},"dockId":{"anyOf":[{"type":"string"},{"type":"null"}]},"dropLocationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"holdingOrganizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"organizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"rescheduledByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdByUserId":{"type":"string"},"sentByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"proposedByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"parentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"trailerNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"truckIdentifier":{"anyOf":[{"type":"string"},{"type":"null"}]},"driverName":{"anyOf":[{"type":"string"},{"type":"null"}]},"driverPhone":{"anyOf":[{"type":"string"},{"type":"null"}]},"selfCheckedIn":{"type":"boolean"},"scheduledAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"checkedInAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"atDockAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"droppedOffAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"readyForPickupAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastRequestSentAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"firstScheduledAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"arrivedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"departedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"shipmentId":{"type":"string"},"wmsNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"orderNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"referenceNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"resentCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"recurringAppointmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"schedulingMethodId":{"anyOf":[{"type":"string"},{"type":"null"}]},"rescheduleCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["status","unloadingType","loadingType","complianceStatus","direction","priority","id","date","dateTz","detention","ftl","duration","palletCount","description","rejectionReason","dueDate","targetDate","targetDateEnd","overflow","requestedDateEnd","stopNumber","scheduledTimeRangeEnd","timeNotNeeded","dateEnd","externalId","confirmationNumber","originSourceId","lumper","facilityId","dockId","dropLocationId","holdingOrganizationId","organizationId","rescheduledByUserId","createdByUserId","sentByUserId","proposedByUserId","parentId","trailerNumber","truckIdentifier","driverName","driverPhone","selfCheckedIn","scheduledAt","checkedInAt","atDockAt","droppedOffAt","readyForPickupAt","completedAt","createdAt","updatedAt","lastRequestSentAt","firstScheduledAt","arrivedAt","departedAt","shipmentId","wmsNumber","orderNumber","referenceNumber","resentCount","recurringAppointmentId","schedulingMethodId","rescheduleCount"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.NOT_FOUND"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}},"/appointment":{"post":{"operationId":"appointment-create","description":"Creates a new appointment.\n      \nYou must provide either an existing facility's `faciltiyId` or details for a new facility.","tags":["appointment"],"security":[{"Authorization":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"facility":{"type":"object","properties":{"name":{"description":"The name of the facility.","type":"string","minLength":1},"street":{"description":"The street address of the facility.","type":"string","minLength":1},"suite":{"description":"The suite number of the facility.","type":"string"},"zipcode":{"description":"The zip/postal code of the facility.","type":"string","minLength":1},"city":{"description":"The city of the facility.","type":"string","minLength":1},"state":{"description":"The state of the facility.","type":"string","minLength":1},"phoneNumber":{"description":"The phone number of the facility.","type":"string"},"email":{"description":"The email of the facility.","type":"string","pattern":"^[a-zA-Z0-9._%+&'-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"},"country":{"description":"The country of the facility.","type":"string","enum":["US","MX","CA"]},"notes":{"description":"Notes about the facility.","type":"string"}},"required":["name","street","zipcode","city","state","country"]},"facilityId":{"description":"The ID of the facility this appointment belongs to.","type":"string"},"shipmentId":{"description":"The ID of the shipment this appointment belongs to.","type":"string"},"direction":{"description":"The direction of the appointment.","type":"string","enum":["Inbound","Outbound"]},"unloadingType":{"description":"The type of unloading operation.","type":"string","enum":["Live","Drop"]},"loadingType":{"description":"The type of loading method.","type":"string","enum":["Pallet","Case","Floor","SlipSheet","Bale","Corrugated","Crate","Drum","Gaylord","Roll","Skid","Other"]},"palletCount":{"description":"The number of pallets for this appointment.","anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"description":{"description":"Additional notes or description for the appointment.","type":"string"},"ftl":{"description":"Full Truck Load (FTL) indicator. When true, the appointment is for a full truck load. When false, it is Less Than Truckload (LTL). Defaults to true.","type":"boolean"},"targetDate":{"description":"The preferred or target date/time for the appointment. May be used in conjunction with targetDateEnd to specify a time range.","anyOf":[{"type":"string","pattern":"^\\d{4}-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1])$"},{"type":"string","pattern":"^\\d{4}-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1])T([0-1][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])Z$"}]},"targetDateEnd":{"description":"The end of the target date/time range. Used to specify a preferred time window. Must be greater than or equal to targetDate.","anyOf":[{"type":"string","pattern":"^\\d{4}-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1])$"},{"type":"string","pattern":"^\\d{4}-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1])T([0-1][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])Z$"}]},"trailerNumber":{"description":"The trailer number for this appointment.","type":"string"},"truckIdentifier":{"description":"An identifier for the truck.","type":"string"},"driverName":{"description":"The name of the driver for this appointment.","type":"string"},"driverPhone":{"description":"The phone number of the driver for this appointment.","type":"string"},"wmsNumber":{"description":"Warehouse Management System (WMS) number. This field is only used for Warehouse organization types.","type":"string"},"orderNumber":{"description":"Order number of the appointment (PU / DEL number). This is the primary field for appointment identification.","type":"string"},"referenceNumber":{"description":"Reference number for the appointment.","type":"string"},"duration":{"description":"The duration of the appointment in minutes.","type":"integer","minimum":0,"maximum":9007199254740991},"lumper":{"description":"Whether the appointment is a lumper appointment. Also known as \"Driver Assistance Requested\" or \"Hand Bombing Requested.\"","type":"boolean"},"status":{"description":"The status of the appointment. Defaults to \"Draft\". Use \"NotApplicable\" to build a full shipment but ignore the appointment during scheduling.","type":"string","enum":["Draft","NotApplicable"]},"originSourceId":{"description":"An optional ID, use this field to store your internal system stop id for future reference","anyOf":[{"type":"string"},{"type":"null"}]},"purchaseOrders":{}},"required":["shipmentId","direction","unloadingType","purchaseOrders"],"additionalProperties":false}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["Started","Unscheduled","Draft","Pending","Scheduled","CheckedIn","AtDock","DroppedOff","ReadyForPickup","Canceled","Completed","Declined","Refused","OnHold","Expired","Rescheduled","NotApplicable"]},"unloadingType":{"type":"string","enum":["Live","Drop"]},"loadingType":{"anyOf":[{"type":"string","enum":["Pallet","Case","Floor","SlipSheet","Bale","Corrugated","Crate","Drum","Gaylord","Roll","Skid","Other"]},{"type":"null"}]},"complianceStatus":{"anyOf":[{"type":"string","enum":["OnTime","Late","Unplanned","Early","NoShow","LateWorkIn"]},{"type":"null"}]},"direction":{"type":"string","enum":["Inbound","Outbound"]},"priority":{"type":"string","enum":["High","Medium","None"]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"date":{"type":"string"},"dateTz":{"anyOf":[{"type":"string"},{"type":"null"}]},"detention":{"type":"boolean"},"ftl":{"type":"boolean"},"duration":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"palletCount":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"rejectionReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"dueDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"targetDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"targetDateEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"overflow":{"type":"boolean"},"requestedDateEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"stopNumber":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"scheduledTimeRangeEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"timeNotNeeded":{"type":"boolean"},"dateEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"externalId":{"anyOf":[{"type":"string"},{"type":"null"}]},"confirmationNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"originSourceId":{"anyOf":[{"type":"string"},{"type":"null"}]},"lumper":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"facilityId":{"type":"string"},"dockId":{"anyOf":[{"type":"string"},{"type":"null"}]},"dropLocationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"holdingOrganizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"organizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"rescheduledByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdByUserId":{"type":"string"},"sentByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"proposedByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"parentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"trailerNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"truckIdentifier":{"anyOf":[{"type":"string"},{"type":"null"}]},"driverName":{"anyOf":[{"type":"string"},{"type":"null"}]},"driverPhone":{"anyOf":[{"type":"string"},{"type":"null"}]},"selfCheckedIn":{"type":"boolean"},"scheduledAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"checkedInAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"atDockAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"droppedOffAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"readyForPickupAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastRequestSentAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"firstScheduledAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"arrivedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"departedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"shipmentId":{"type":"string"},"wmsNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"orderNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"referenceNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"resentCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"recurringAppointmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"schedulingMethodId":{"anyOf":[{"type":"string"},{"type":"null"}]},"rescheduleCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"facility":{"type":"object","properties":{"status":{"type":"string","enum":["Operational","ClosedTemporarily","ClosedPermanently"]},"type":{"type":"string","enum":["Verified","External","Internal"]},"country":{"type":"string","enum":["US","MX","CA"]},"schedulingType":{"anyOf":[{"type":"string","enum":["Appointment","FirstComeFirstServe"]},{"type":"null"}]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"name":{"type":"string"},"phoneNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"irc":{"anyOf":[{"type":"string"},{"type":"null"}]},"deleted":{"anyOf":[{"type":"string"},{"type":"null"}]},"street":{"type":"string"},"suite":{"anyOf":[{"type":"string"},{"type":"null"}]},"zipcode":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"latitude":{"type":"string"},"longitude":{"type":"string"},"timeZone":{"type":"string"},"deprecated":{"type":"boolean"},"organizationId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"amenities":{"anyOf":[{"type":"string"},{"type":"null"}]},"cutOffTime":{"type":"string"},"schedulingDaysAheadMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"schedulingDaysAheadMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"allowSameDayReschedule":{"type":"boolean"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"selfCheckIn":{"type":"boolean"},"placeKeyId":{"anyOf":[{"type":"string"},{"type":"null"}]},"requiredFields":{"anyOf":[{"$ref":"#/components/schemas/__schema1"},{"type":"null"}]},"thirdPartyId":{"anyOf":[{"type":"string"},{"type":"null"}]},"originalId":{"anyOf":[{"type":"string"},{"type":"null"}]},"autoConfirmAppointments":{"type":"boolean"},"reasonCodesEnabled":{"type":"boolean"}},"required":["status","type","country","schedulingType","id","name","phoneNumber","email","irc","deleted","street","suite","zipcode","city","state","latitude","longitude","timeZone","deprecated","organizationId","createdAt","updatedAt","amenities","cutOffTime","schedulingDaysAheadMin","schedulingDaysAheadMax","allowSameDayReschedule","notes","selfCheckIn","placeKeyId","requiredFields","thirdPartyId","originalId","autoConfirmAppointments","reasonCodesEnabled"],"additionalProperties":false}},"required":["status","unloadingType","loadingType","complianceStatus","direction","priority","id","date","dateTz","detention","ftl","duration","palletCount","description","rejectionReason","dueDate","targetDate","targetDateEnd","overflow","requestedDateEnd","stopNumber","scheduledTimeRangeEnd","timeNotNeeded","dateEnd","externalId","confirmationNumber","originSourceId","lumper","facilityId","dockId","dropLocationId","holdingOrganizationId","organizationId","rescheduledByUserId","createdByUserId","sentByUserId","proposedByUserId","parentId","trailerNumber","truckIdentifier","driverName","driverPhone","selfCheckedIn","scheduledAt","checkedInAt","atDockAt","droppedOffAt","readyForPickupAt","completedAt","createdAt","updatedAt","lastRequestSentAt","firstScheduledAt","arrivedAt","departedAt","shipmentId","wmsNumber","orderNumber","referenceNumber","resentCount","recurringAppointmentId","schedulingMethodId","rescheduleCount","facility"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}},"/appointment/{appointmentId}/comments":{"get":{"operationId":"appointment-getComments","description":"Lists all comments on a given appointment","tags":["appointment"],"security":[{"Authorization":[]}],"parameters":[{"in":"path","name":"appointmentId","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"subject":{"anyOf":[{"type":"string"},{"type":"null"}]},"body":{"type":"string"},"cc":{"anyOf":[{"type":"string"},{"type":"null"}]},"appointmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"user":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"}},"required":["name","email","id"],"additionalProperties":false},{"type":"null"}]}},"required":["id","subject","body","cc","appointmentId","createdAt","updatedAt","user"],"additionalProperties":false}}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.NOT_FOUND"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}},"post":{"operationId":"appointment-createComment","description":"Adds a new comment to a given appointment","tags":["appointment"],"security":[{"Authorization":[]}],"parameters":[{"in":"path","name":"appointmentId","schema":{"type":"string"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"comment":{"type":"object","properties":{"body":{"type":"string"}},"required":["body"]}},"required":["comment"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"subject":{"anyOf":[{"type":"string"},{"type":"null"}]},"body":{"type":"string"},"cc":{"anyOf":[{"type":"string"},{"type":"null"}]},"appointmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"user":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"}},"required":["name","email","id"],"additionalProperties":false},{"type":"null"}]}},"required":["id","subject","body","cc","appointmentId","createdAt","updatedAt","user"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}},"/appointment/{appointmentId}/timeline":{"get":{"operationId":"appointment-getTimeline","description":"Lists all changes to a given appointment","tags":["appointment"],"security":[{"Authorization":[]}],"parameters":[{"in":"path","name":"appointmentId","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"itemType":{"type":"string","enum":["Appointment"]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"itemId":{"type":"string"},"authorId":{"anyOf":[{"type":"string"},{"type":"null"}]},"object":{"$ref":"#/components/schemas/__schema1"},"changes":{"type":"array","items":{"type":"object","properties":{"op":{"type":"string","enum":["add","replace","remove"]},"path":{"type":"array","items":{"type":"string"}},"value":{}},"required":["op","path","value"],"additionalProperties":false}},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"log":{"anyOf":[{"type":"string"},{"type":"null"}]},"message":{"type":"object","properties":{"author":{"anyOf":[{"type":"object","properties":{"role":{"anyOf":[{"type":"string","enum":["SuperAdmin","Admin","Member","Limited","ViewOnly","DistributionList"]},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["Active","Disabled","Invited"]},{"type":"null"}]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastName":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailVerified":{"anyOf":[{"type":"string"},{"type":"null"}]},"image":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"signature":{"type":"boolean"},"signatureImageUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"signatureDisclaimer":{"anyOf":[{"type":"string"},{"type":"null"}]},"organizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastActiveAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"bpadmin":{"type":"boolean"}},"required":["role","status","id","name","lastName","email","emailVerified","image","phone","jobTitle","signature","signatureImageUrl","signatureDisclaimer","organizationId","createdAt","updatedAt","lastActiveAt","bpadmin"],"additionalProperties":false},{"type":"null"}]},"date":{"anyOf":[{"type":"string"},{"type":"null"}]},"message":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["author","date","message"],"additionalProperties":false}},"required":["itemType","id","itemId","authorId","object","changes","createdAt","updatedAt","log","message"],"additionalProperties":false}}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.NOT_FOUND"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}},"/appointment/{appointmentId}/files":{"post":{"operationId":"appointment-attachFile","description":"Attaches a document to an appointment","tags":["appointment"],"security":[{"Authorization":[]}],"parameters":[{"in":"path","name":"appointmentId","schema":{"type":"string"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"file":{"type":"string"},"filename":{"type":"string"}},"required":["file","filename"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"}},"required":["id","url"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}},"get":{"operationId":"appointment-getFiles","description":"Lists the files attached to a given appointment","tags":["appointment"],"security":[{"Authorization":[]}],"parameters":[{"in":"path","name":"appointmentId","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"appointmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"name":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"user":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"}},"required":["name","email","id"],"additionalProperties":false},"url":{"type":"string"}},"required":["id","appointmentId","createdAt","name","updatedAt","user","url"],"additionalProperties":false}}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.NOT_FOUND"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}},"/appointment/{appointmentId}/schedule":{"post":{"operationId":"appointment-schedule","description":"Use this endpoint to schedule the appointment with the third parties.","tags":["appointment"],"security":[{"Authorization":[]}],"parameters":[{"in":"path","name":"appointmentId","schema":{"type":"string"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"to":{"description":"(FCFS) An array of email addresses the appointment request should be sent to. (Optional)","type":"array","items":{"type":"string","pattern":"^[a-zA-Z0-9._%+&'-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"}},"date":{"description":"(Portal) The date the appointment is requested. (Optional - provide either preferredTimes or date/time/timerange)","type":"string","pattern":"^\\d{4}-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1])$"},"from":{"description":"(Email) This email address should be already saved as a \"distribution list\" on BiggerPicture. (Optional)","type":"string","pattern":"^[a-zA-Z0-9._%+&'-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"},"time":{"description":"(Portal) The time the appointment is requested at. (Optional - provide either preferredTimes or date/time/timerange)","type":"string","pattern":"^([0-1][0-9]|2[0-3]):([0-5][0-9])$"},"timeRange":{"description":"(Email) Window of hours around the requested appointment time. (1-3 hours) (Optional)","type":"integer","minimum":1,"maximum":3},"subject":{"description":"(Email) Override for the default subject of the email (Optional)","type":"string"},"message":{"description":"(Email) Override for the default message of the email. It supports the {{var}} placeholders (Optional)","type":"string"},"apiKeyId":{"description":"(Portal) The id of the ApiKey to use for scheduling. (Optional)","type":"string"},"preferredTimes":{"minItems":1,"type":"array","items":{"type":"array","prefixItems":[{"type":"string","pattern":"^\\d{4}-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1])$"},{"type":"string","pattern":"^([0-1][0-9]|2[0-3]):([0-5][0-9])$"}]}},"timerange":{"description":"(Portal) Window of hours around the requested appointment time. (1-12 hours) (Optional)","type":"integer","minimum":1,"maximum":12},"vendor":{"description":"(Portal) The third party vendor to schedule on. Note: you must provide credentials for this vendor in BiggerPicture UI first. (Required)","type":"string","enum":["e2open","e2openThirdParty","opendock","rydershare","rydersharetarget","manhattanaldi","manhattanhomedepot","manhattansysco","manhattanpublix","retalix","blueyonderpepsico","blueyonderpepsico3p","blueyonderpandg","retaillink","uberfreight","uberfreight3p","onenetwork","costco","c3cswg","c3dollartree","c3familydollar","c3aldi","fourkites","publix","otmwestrock","otmconagra","datadocks","i3pl","lineagelink","sapdas","biggerpicture","capstone","refresco","descartesbasspro","amazoninbound","lowes","conduit","otmniagara","unfi","transporeon"]},"comment":{"description":"A comment to be added to the scheduling request. Support varies depending on the portal. (Optional)","type":"string"},"method":{"type":"string","enum":["email","fcfs","portal"]}},"required":["method"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["Started","Unscheduled","Draft","Pending","Scheduled","CheckedIn","AtDock","DroppedOff","ReadyForPickup","Canceled","Completed","Declined","Refused","OnHold","Expired","Rescheduled","NotApplicable"]},"unloadingType":{"type":"string","enum":["Live","Drop"]},"loadingType":{"anyOf":[{"type":"string","enum":["Pallet","Case","Floor","SlipSheet","Bale","Corrugated","Crate","Drum","Gaylord","Roll","Skid","Other"]},{"type":"null"}]},"complianceStatus":{"anyOf":[{"type":"string","enum":["OnTime","Late","Unplanned","Early","NoShow","LateWorkIn"]},{"type":"null"}]},"direction":{"type":"string","enum":["Inbound","Outbound"]},"priority":{"type":"string","enum":["High","Medium","None"]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"date":{"type":"string"},"dateTz":{"anyOf":[{"type":"string"},{"type":"null"}]},"detention":{"type":"boolean"},"ftl":{"type":"boolean"},"duration":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"palletCount":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"rejectionReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"dueDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"targetDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"targetDateEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"overflow":{"type":"boolean"},"requestedDateEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"stopNumber":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"scheduledTimeRangeEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"timeNotNeeded":{"type":"boolean"},"dateEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"externalId":{"anyOf":[{"type":"string"},{"type":"null"}]},"confirmationNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"originSourceId":{"anyOf":[{"type":"string"},{"type":"null"}]},"lumper":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"facilityId":{"type":"string"},"dockId":{"anyOf":[{"type":"string"},{"type":"null"}]},"dropLocationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"holdingOrganizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"organizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"rescheduledByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdByUserId":{"type":"string"},"sentByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"proposedByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"parentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"trailerNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"truckIdentifier":{"anyOf":[{"type":"string"},{"type":"null"}]},"driverName":{"anyOf":[{"type":"string"},{"type":"null"}]},"driverPhone":{"anyOf":[{"type":"string"},{"type":"null"}]},"selfCheckedIn":{"type":"boolean"},"scheduledAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"checkedInAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"atDockAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"droppedOffAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"readyForPickupAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastRequestSentAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"firstScheduledAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"arrivedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"departedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"shipmentId":{"type":"string"},"wmsNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"orderNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"referenceNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"resentCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"recurringAppointmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"schedulingMethodId":{"anyOf":[{"type":"string"},{"type":"null"}]},"rescheduleCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["status","unloadingType","loadingType","complianceStatus","direction","priority","id","date","dateTz","detention","ftl","duration","palletCount","description","rejectionReason","dueDate","targetDate","targetDateEnd","overflow","requestedDateEnd","stopNumber","scheduledTimeRangeEnd","timeNotNeeded","dateEnd","externalId","confirmationNumber","originSourceId","lumper","facilityId","dockId","dropLocationId","holdingOrganizationId","organizationId","rescheduledByUserId","createdByUserId","sentByUserId","proposedByUserId","parentId","trailerNumber","truckIdentifier","driverName","driverPhone","selfCheckedIn","scheduledAt","checkedInAt","atDockAt","droppedOffAt","readyForPickupAt","completedAt","createdAt","updatedAt","lastRequestSentAt","firstScheduledAt","arrivedAt","departedAt","shipmentId","wmsNumber","orderNumber","referenceNumber","resentCount","recurringAppointmentId","schedulingMethodId","rescheduleCount"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}},"/appointment/{appointmentId}/scheduling-method":{"get":{"operationId":"appointment-schedulingMethod","description":"This endpoint returns the scheduling method for a given appointment, as well as the relevant data used when previously scheduling at the appointment facility.\n    \nFor instance, if this facility schedules via email, and the last appointment request was sent at `orders@facility.com` this email will be included in the `to` field.\n\nIf this is the first time scheduling at this facility, the response type will be `unknown`","tags":["appointment"],"security":[{"Authorization":[]}],"parameters":[{"in":"path","name":"appointmentId","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"method":{"description":"There is no scheduling method attached to this facility, providing a method will be needed to schedule this appointment.","type":"string","const":"unknown"}},"required":["method"],"additionalProperties":false},{"type":"object","properties":{"method":{"description":"This facility schedule its appointments over email.","type":"string","const":"email"},"to":{"type":"array","items":{"type":"string","pattern":"^[a-zA-Z0-9._%+&'-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"}},"cc":{"type":"array","items":{"type":"string","pattern":"^[a-zA-Z0-9._%+&'-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"}},"notes":{"anyOf":[{"description":"Optional information","type":"string"},{"type":"null"}]}},"required":["method"],"additionalProperties":false},{"type":"object","properties":{"method":{"description":"This facility is using BiggerPicture to schedule its appointments.","type":"string","const":"biggerpicture"},"availableTimes":{"type":"array","items":{"description":"An array of ISO8601 strings of bookable times at the facility. Use `timezone` to properly format the time in the facility time zone","type":"string","pattern":"^\\d{4}-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1])T([0-1][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])Z$"}},"timezone":{"description":"The full IANA TZ name. e.g. \"America/Los_Angeles\"","type":"string"}},"required":["method","availableTimes","timezone"],"additionalProperties":false},{"type":"object","properties":{"method":{"description":"This facility schedules its appointments on a portal.","type":"string","const":"portal"},"url":{"description":"The portal URL used to schedule.","type":"string"},"notes":{"anyOf":[{"description":"Optional information","type":"string"},{"type":"null"}]}},"required":["method","url"],"additionalProperties":false},{"type":"object","properties":{"method":{"description":"This facility schedules its appointments by phone.","type":"string","const":"phone"},"phoneNumber":{"description":"The phone number this facility is reachable at.","type":"string"},"notes":{"anyOf":[{"description":"Optional information","type":"string"},{"type":"null"}]}},"required":["method","phoneNumber"],"additionalProperties":false}]}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.NOT_FOUND"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}},"/appointment/{appointmentId}/recommended-time":{"get":{"operationId":"appointment-recommendedTime","description":"This endpoint gives the recommended appointment time for a given appointment","tags":["appointment"],"security":[{"Authorization":[]}],"parameters":[{"in":"path","name":"appointmentId","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"recommendedTime":{"description":"A ISO8601 string of the recommended time. Use `timezone` to properly format the time in the facility time zone","type":"string","pattern":"^\\d{4}-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1])T([0-1][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])Z$"},"timezone":{"description":"The full IANA TZ name. e.g. \"America/Los_Angeles\"","type":"string"}},"required":["recommendedTime","timezone"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.NOT_FOUND"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}},"/appointment/{appointmentId}/reschedule":{"post":{"operationId":"appointment-reschedule","description":"Use this endpoint to reschedule the appointment with third parties.","tags":["appointment"],"security":[{"Authorization":[]}],"parameters":[{"in":"path","name":"appointmentId","schema":{"type":"string"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"to":{"description":"(FCFS) An array of email addresses the appointment request should be sent to. (Optional)","type":"array","items":{"type":"string","pattern":"^[a-zA-Z0-9._%+&'-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"}},"date":{"description":"(Portal) The date the appointment is requested. (Optional - provide either preferredTimes or date/time/timerange)","type":"string","pattern":"^\\d{4}-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1])$"},"from":{"description":"(Email) This email address should be already saved as a \"distribution list\" on BiggerPicture. (Optional)","type":"string","pattern":"^[a-zA-Z0-9._%+&'-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"},"time":{"description":"(Portal) The time the appointment is requested at. (Optional - provide either preferredTimes or date/time/timerange)","type":"string","pattern":"^([0-1][0-9]|2[0-3]):([0-5][0-9])$"},"timeRange":{"description":"(Email) Window of hours around the requested appointment time. (1-3 hours) (Optional)","type":"integer","minimum":1,"maximum":3},"subject":{"description":"(Email) Override for the default subject of the email (Optional)","type":"string"},"message":{"description":"(Email) Override for the default message of the email. It supports the {{var}} placeholders (Optional)","type":"string"},"apiKeyId":{"description":"(Portal) The id of the ApiKey to use for scheduling. (Optional)","type":"string"},"preferredTimes":{"minItems":1,"type":"array","items":{"type":"array","prefixItems":[{"type":"string","pattern":"^\\d{4}-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1])$"},{"type":"string","pattern":"^([0-1][0-9]|2[0-3]):([0-5][0-9])$"}]}},"timerange":{"description":"(Portal) Window of hours around the requested appointment time. (1-12 hours) (Optional)","type":"integer","minimum":1,"maximum":12},"vendor":{"description":"(Portal) The third party vendor to schedule on. Note: you must provide credentials for this vendor in BiggerPicture UI first. (Required)","type":"string","enum":["e2open","e2openThirdParty","opendock","rydershare","rydersharetarget","manhattanaldi","manhattanhomedepot","manhattansysco","manhattanpublix","retalix","blueyonderpepsico","blueyonderpepsico3p","blueyonderpandg","retaillink","uberfreight","uberfreight3p","onenetwork","costco","c3cswg","c3dollartree","c3familydollar","c3aldi","fourkites","publix","otmwestrock","otmconagra","datadocks","i3pl","lineagelink","sapdas","biggerpicture","capstone","refresco","descartesbasspro","amazoninbound","lowes","conduit","otmniagara","unfi","transporeon"]},"comment":{"description":"A comment to be added to the scheduling request. Support varies depending on the portal. (Optional)","type":"string"},"method":{"type":"string","enum":["email","fcfs","portal"]}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["Started","Unscheduled","Draft","Pending","Scheduled","CheckedIn","AtDock","DroppedOff","ReadyForPickup","Canceled","Completed","Declined","Refused","OnHold","Expired","Rescheduled","NotApplicable"]},"unloadingType":{"type":"string","enum":["Live","Drop"]},"loadingType":{"anyOf":[{"type":"string","enum":["Pallet","Case","Floor","SlipSheet","Bale","Corrugated","Crate","Drum","Gaylord","Roll","Skid","Other"]},{"type":"null"}]},"complianceStatus":{"anyOf":[{"type":"string","enum":["OnTime","Late","Unplanned","Early","NoShow","LateWorkIn"]},{"type":"null"}]},"direction":{"type":"string","enum":["Inbound","Outbound"]},"priority":{"type":"string","enum":["High","Medium","None"]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"date":{"type":"string"},"dateTz":{"anyOf":[{"type":"string"},{"type":"null"}]},"detention":{"type":"boolean"},"ftl":{"type":"boolean"},"duration":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"palletCount":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"rejectionReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"dueDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"targetDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"targetDateEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"overflow":{"type":"boolean"},"requestedDateEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"stopNumber":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"scheduledTimeRangeEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"timeNotNeeded":{"type":"boolean"},"dateEnd":{"anyOf":[{"type":"string"},{"type":"null"}]},"externalId":{"anyOf":[{"type":"string"},{"type":"null"}]},"confirmationNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"originSourceId":{"anyOf":[{"type":"string"},{"type":"null"}]},"lumper":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"facilityId":{"type":"string"},"dockId":{"anyOf":[{"type":"string"},{"type":"null"}]},"dropLocationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"holdingOrganizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"organizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"rescheduledByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdByUserId":{"type":"string"},"sentByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"proposedByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"parentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"trailerNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"truckIdentifier":{"anyOf":[{"type":"string"},{"type":"null"}]},"driverName":{"anyOf":[{"type":"string"},{"type":"null"}]},"driverPhone":{"anyOf":[{"type":"string"},{"type":"null"}]},"selfCheckedIn":{"type":"boolean"},"scheduledAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"checkedInAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"atDockAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"droppedOffAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"readyForPickupAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastRequestSentAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"firstScheduledAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"arrivedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"departedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"shipmentId":{"type":"string"},"wmsNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"orderNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"referenceNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"resentCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"recurringAppointmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"schedulingMethodId":{"anyOf":[{"type":"string"},{"type":"null"}]},"rescheduleCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["status","unloadingType","loadingType","complianceStatus","direction","priority","id","date","dateTz","detention","ftl","duration","palletCount","description","rejectionReason","dueDate","targetDate","targetDateEnd","overflow","requestedDateEnd","stopNumber","scheduledTimeRangeEnd","timeNotNeeded","dateEnd","externalId","confirmationNumber","originSourceId","lumper","facilityId","dockId","dropLocationId","holdingOrganizationId","organizationId","rescheduledByUserId","createdByUserId","sentByUserId","proposedByUserId","parentId","trailerNumber","truckIdentifier","driverName","driverPhone","selfCheckedIn","scheduledAt","checkedInAt","atDockAt","droppedOffAt","readyForPickupAt","completedAt","createdAt","updatedAt","lastRequestSentAt","firstScheduledAt","arrivedAt","departedAt","shipmentId","wmsNumber","orderNumber","referenceNumber","resentCount","recurringAppointmentId","schedulingMethodId","rescheduleCount"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}},"/webhook/{webhookId}":{"get":{"operationId":"webhook-get","description":"Retrieves one of your organization's webhooks","tags":["webhook"],"security":[{"Authorization":[]}],"parameters":[{"in":"path","name":"webhookId","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"url":{"type":"string"},"organizationId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"extraHeaders":{"anyOf":[{"$ref":"#/components/schemas/__schema1"},{"type":"null"}]},"oauthTokenEndpoint":{"anyOf":[{"type":"string"},{"type":"null"}]},"oauthClientId":{"anyOf":[{"type":"string"},{"type":"null"}]},"oauthClientSecret":{"anyOf":[{"type":"string"},{"type":"null"}]},"oauthScopes":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","url","organizationId","createdAt","updatedAt","extraHeaders","oauthTokenEndpoint","oauthClientId","oauthClientSecret","oauthScopes"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.NOT_FOUND"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}},"put":{"operationId":"webhook-update","description":"Updates one of your organization's webhooks","tags":["webhook"],"security":[{"Authorization":[]}],"parameters":[{"in":"path","name":"webhookId","schema":{"type":"string"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"url":{"type":"string"},"organizationId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"extraHeaders":{"anyOf":[{"$ref":"#/components/schemas/__schema0"},{"type":"null"}]},"oauthTokenEndpoint":{"anyOf":[{"type":"string"},{"type":"null"}]},"oauthClientId":{"anyOf":[{"type":"string"},{"type":"null"}]},"oauthClientSecret":{"anyOf":[{"type":"string"},{"type":"null"}]},"oauthScopes":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","url","organizationId","createdAt","updatedAt","extraHeaders","oauthTokenEndpoint","oauthClientId","oauthClientSecret","oauthScopes"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"url":{"type":"string"},"organizationId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"extraHeaders":{"anyOf":[{"$ref":"#/components/schemas/__schema1"},{"type":"null"}]},"oauthTokenEndpoint":{"anyOf":[{"type":"string"},{"type":"null"}]},"oauthClientId":{"anyOf":[{"type":"string"},{"type":"null"}]},"oauthClientSecret":{"anyOf":[{"type":"string"},{"type":"null"}]},"oauthScopes":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","url","organizationId","createdAt","updatedAt","extraHeaders","oauthTokenEndpoint","oauthClientId","oauthClientSecret","oauthScopes"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.NOT_FOUND"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}},"delete":{"operationId":"webhook-delete","description":"Deletes one of your organization's webhooks","tags":["webhook"],"security":[{"Authorization":[]}],"parameters":[{"in":"path","name":"webhookId","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"url":{"type":"string"},"organizationId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"extraHeaders":{"anyOf":[{"$ref":"#/components/schemas/__schema1"},{"type":"null"}]},"oauthTokenEndpoint":{"anyOf":[{"type":"string"},{"type":"null"}]},"oauthClientId":{"anyOf":[{"type":"string"},{"type":"null"}]},"oauthClientSecret":{"anyOf":[{"type":"string"},{"type":"null"}]},"oauthScopes":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","url","organizationId","createdAt","updatedAt","extraHeaders","oauthTokenEndpoint","oauthClientId","oauthClientSecret","oauthScopes"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.NOT_FOUND"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}},"/webhook":{"get":{"operationId":"webhook-list","description":"Lists all of your organization's webhooks","tags":["webhook"],"security":[{"Authorization":[]}],"parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"url":{"type":"string"},"organizationId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"extraHeaders":{"anyOf":[{"$ref":"#/components/schemas/__schema1"},{"type":"null"}]},"oauthTokenEndpoint":{"anyOf":[{"type":"string"},{"type":"null"}]},"oauthClientId":{"anyOf":[{"type":"string"},{"type":"null"}]},"oauthClientSecret":{"anyOf":[{"type":"string"},{"type":"null"}]},"oauthScopes":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","url","organizationId","createdAt","updatedAt","extraHeaders","oauthTokenEndpoint","oauthClientId","oauthClientSecret","oauthScopes"],"additionalProperties":false}}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.NOT_FOUND"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}},"post":{"operationId":"webhook-create","description":"Creates a new webhook for your organization","tags":["webhook"],"security":[{"Authorization":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1},"url":{"type":"string","minLength":1},"extraHeaders":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"owners":{"minItems":1,"type":"array","items":{"type":"string","pattern":"^[a-zA-Z0-9._%+&'-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"}},"oauth":{"type":"object","properties":{"oauthTokenEndpoint":{"type":"string","format":"uri"},"oauthClientId":{"type":"string","minLength":1},"oauthScopes":{"type":"string"},"oauthClientSecret":{"type":"string","minLength":1}},"required":["oauthTokenEndpoint","oauthClientId","oauthClientSecret"]}},"required":["name","url","owners"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"url":{"type":"string"},"organizationId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"extraHeaders":{"anyOf":[{"$ref":"#/components/schemas/__schema1"},{"type":"null"}]},"oauthTokenEndpoint":{"anyOf":[{"type":"string"},{"type":"null"}]},"oauthClientId":{"anyOf":[{"type":"string"},{"type":"null"}]},"oauthClientSecret":{"anyOf":[{"type":"string"},{"type":"null"}]},"oauthScopes":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","url","organizationId","createdAt","updatedAt","extraHeaders","oauthTokenEndpoint","oauthClientId","oauthClientSecret","oauthScopes"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}},"/facility":{"get":{"operationId":"facility-list","description":"Lists all the facilities you created","tags":["facility"],"security":[{"Authorization":[]}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["Operational","ClosedTemporarily","ClosedPermanently"]},"type":{"type":"string","enum":["Verified","External","Internal"]},"country":{"type":"string","enum":["US","MX","CA"]},"schedulingType":{"anyOf":[{"type":"string","enum":["Appointment","FirstComeFirstServe"]},{"type":"null"}]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"name":{"type":"string"},"phoneNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"irc":{"anyOf":[{"type":"string"},{"type":"null"}]},"deleted":{"anyOf":[{"type":"string"},{"type":"null"}]},"street":{"type":"string"},"suite":{"anyOf":[{"type":"string"},{"type":"null"}]},"zipcode":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"latitude":{"type":"string"},"longitude":{"type":"string"},"timeZone":{"type":"string"},"deprecated":{"type":"boolean"},"organizationId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"amenities":{"anyOf":[{"type":"string"},{"type":"null"}]},"cutOffTime":{"type":"string"},"schedulingDaysAheadMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"schedulingDaysAheadMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"allowSameDayReschedule":{"type":"boolean"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"selfCheckIn":{"type":"boolean"},"placeKeyId":{"anyOf":[{"type":"string"},{"type":"null"}]},"requiredFields":{"anyOf":[{"$ref":"#/components/schemas/__schema1"},{"type":"null"}]},"thirdPartyId":{"anyOf":[{"type":"string"},{"type":"null"}]},"originalId":{"anyOf":[{"type":"string"},{"type":"null"}]},"autoConfirmAppointments":{"type":"boolean"},"reasonCodesEnabled":{"type":"boolean"}},"required":["status","type","country","schedulingType","id","name","phoneNumber","email","irc","deleted","street","suite","zipcode","city","state","latitude","longitude","timeZone","deprecated","organizationId","createdAt","updatedAt","amenities","cutOffTime","schedulingDaysAheadMin","schedulingDaysAheadMax","allowSameDayReschedule","notes","selfCheckIn","placeKeyId","requiredFields","thirdPartyId","originalId","autoConfirmAppointments","reasonCodesEnabled"],"additionalProperties":false}}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}},"post":{"operationId":"facility-create","description":"Creates a facility","tags":["facility"],"security":[{"Authorization":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"The name of the facility.","type":"string","minLength":1},"street":{"description":"The street address of the facility.","type":"string","minLength":1},"suite":{"description":"The suite number of the facility.","type":"string"},"zipcode":{"description":"The zip/postal code of the facility.","type":"string","minLength":1},"city":{"description":"The city of the facility.","type":"string","minLength":1},"state":{"description":"The state of the facility.","type":"string","minLength":1},"phoneNumber":{"description":"The phone number of the facility.","type":"string"},"email":{"description":"The email of the facility.","type":"string","pattern":"^[a-zA-Z0-9._%+&'-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"},"country":{"description":"The country of the facility.","type":"string","enum":["US","MX","CA"]},"notes":{"description":"Notes about the facility.","type":"string"}},"required":["name","street","zipcode","city","state","country"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["Operational","ClosedTemporarily","ClosedPermanently"]},"type":{"type":"string","enum":["Verified","External","Internal"]},"country":{"type":"string","enum":["US","MX","CA"]},"schedulingType":{"anyOf":[{"type":"string","enum":["Appointment","FirstComeFirstServe"]},{"type":"null"}]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"name":{"type":"string"},"phoneNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"irc":{"anyOf":[{"type":"string"},{"type":"null"}]},"deleted":{"anyOf":[{"type":"string"},{"type":"null"}]},"street":{"type":"string"},"suite":{"anyOf":[{"type":"string"},{"type":"null"}]},"zipcode":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"latitude":{"type":"string"},"longitude":{"type":"string"},"timeZone":{"type":"string"},"deprecated":{"type":"boolean"},"organizationId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"amenities":{"anyOf":[{"type":"string"},{"type":"null"}]},"cutOffTime":{"type":"string"},"schedulingDaysAheadMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"schedulingDaysAheadMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"allowSameDayReschedule":{"type":"boolean"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"selfCheckIn":{"type":"boolean"},"placeKeyId":{"anyOf":[{"type":"string"},{"type":"null"}]},"requiredFields":{"anyOf":[{"$ref":"#/components/schemas/__schema1"},{"type":"null"}]},"thirdPartyId":{"anyOf":[{"type":"string"},{"type":"null"}]},"originalId":{"anyOf":[{"type":"string"},{"type":"null"}]},"autoConfirmAppointments":{"type":"boolean"},"reasonCodesEnabled":{"type":"boolean"}},"required":["status","type","country","schedulingType","id","name","phoneNumber","email","irc","deleted","street","suite","zipcode","city","state","latitude","longitude","timeZone","deprecated","organizationId","createdAt","updatedAt","amenities","cutOffTime","schedulingDaysAheadMin","schedulingDaysAheadMax","allowSameDayReschedule","notes","selfCheckIn","placeKeyId","requiredFields","thirdPartyId","originalId","autoConfirmAppointments","reasonCodesEnabled"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}},"/facility/{facilityId}":{"get":{"operationId":"facility-get","description":"Retrieves a given facility","tags":["facility"],"security":[{"Authorization":[]}],"parameters":[{"in":"path","name":"facilityId","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["Operational","ClosedTemporarily","ClosedPermanently"]},"type":{"type":"string","enum":["Verified","External","Internal"]},"country":{"type":"string","enum":["US","MX","CA"]},"schedulingType":{"anyOf":[{"type":"string","enum":["Appointment","FirstComeFirstServe"]},{"type":"null"}]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"name":{"type":"string"},"phoneNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"irc":{"anyOf":[{"type":"string"},{"type":"null"}]},"deleted":{"anyOf":[{"type":"string"},{"type":"null"}]},"street":{"type":"string"},"suite":{"anyOf":[{"type":"string"},{"type":"null"}]},"zipcode":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"latitude":{"type":"string"},"longitude":{"type":"string"},"timeZone":{"type":"string"},"deprecated":{"type":"boolean"},"organizationId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"amenities":{"anyOf":[{"type":"string"},{"type":"null"}]},"cutOffTime":{"type":"string"},"schedulingDaysAheadMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"schedulingDaysAheadMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"allowSameDayReschedule":{"type":"boolean"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"selfCheckIn":{"type":"boolean"},"placeKeyId":{"anyOf":[{"type":"string"},{"type":"null"}]},"requiredFields":{"anyOf":[{"$ref":"#/components/schemas/__schema1"},{"type":"null"}]},"thirdPartyId":{"anyOf":[{"type":"string"},{"type":"null"}]},"originalId":{"anyOf":[{"type":"string"},{"type":"null"}]},"autoConfirmAppointments":{"type":"boolean"},"reasonCodesEnabled":{"type":"boolean"}},"required":["status","type","country","schedulingType","id","name","phoneNumber","email","irc","deleted","street","suite","zipcode","city","state","latitude","longitude","timeZone","deprecated","organizationId","createdAt","updatedAt","amenities","cutOffTime","schedulingDaysAheadMin","schedulingDaysAheadMax","allowSameDayReschedule","notes","selfCheckIn","placeKeyId","requiredFields","thirdPartyId","originalId","autoConfirmAppointments","reasonCodesEnabled"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.NOT_FOUND"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}},"/carrier":{"get":{"operationId":"carrier-list","description":"Lists all the carriers with an official account as well as the carriers you added to your carrier list","tags":["carrier"],"security":[{"Authorization":[]}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["Carrier","Customer","Warehouse"]},"carrierType":{"anyOf":[{"type":"string","enum":["Brokerage","Asset","BrokerAsset"]},{"type":"null"}]},"status":{"type":"string","enum":["Active","Disabled","Invited"]},"country":{"type":"string","enum":["US","MX","CA"]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"name":{"type":"string"},"phoneNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"internalDistributionEmail":{"anyOf":[{"type":"string"},{"type":"null"}]},"website":{"anyOf":[{"type":"string"},{"type":"null"}]},"scac":{"anyOf":[{"type":"string"},{"type":"null"}]},"usdot":{"anyOf":[{"type":"string"},{"type":"null"}]},"mcNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"irc":{"anyOf":[{"type":"string"},{"type":"null"}]},"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"suite":{"anyOf":[{"type":"string"},{"type":"null"}]},"zipcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"string"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"string"},{"type":"null"}]},"timeZone":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"deletedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"logoUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailSignatureLogoUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdByOrganizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"originalId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","carrierType","status","country","id","name","phoneNumber","email","internalDistributionEmail","website","scac","usdot","mcNumber","irc","street","suite","zipcode","city","state","latitude","longitude","timeZone","createdAt","updatedAt","deletedAt","logoUrl","emailSignatureLogoUrl","note","createdByOrganizationId","originalId"],"additionalProperties":false}}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}},"/carrier/{carrierId}":{"get":{"operationId":"carrier-get","description":"Retrieves the details for a given carrier organization","tags":["carrier"],"security":[{"Authorization":[]}],"parameters":[{"in":"path","name":"carrierId","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["Carrier","Customer","Warehouse"]},"carrierType":{"anyOf":[{"type":"string","enum":["Brokerage","Asset","BrokerAsset"]},{"type":"null"}]},"status":{"type":"string","enum":["Active","Disabled","Invited"]},"country":{"type":"string","enum":["US","MX","CA"]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"name":{"type":"string"},"phoneNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"internalDistributionEmail":{"anyOf":[{"type":"string"},{"type":"null"}]},"website":{"anyOf":[{"type":"string"},{"type":"null"}]},"scac":{"anyOf":[{"type":"string"},{"type":"null"}]},"usdot":{"anyOf":[{"type":"string"},{"type":"null"}]},"mcNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"irc":{"anyOf":[{"type":"string"},{"type":"null"}]},"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"suite":{"anyOf":[{"type":"string"},{"type":"null"}]},"zipcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"string"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"string"},{"type":"null"}]},"timeZone":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"deletedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"logoUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailSignatureLogoUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdByOrganizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"originalId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","carrierType","status","country","id","name","phoneNumber","email","internalDistributionEmail","website","scac","usdot","mcNumber","irc","street","suite","zipcode","city","state","latitude","longitude","timeZone","createdAt","updatedAt","deletedAt","logoUrl","emailSignatureLogoUrl","note","createdByOrganizationId","originalId"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.NOT_FOUND"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}},"/carrier/search":{"post":{"operationId":"carrier-search","description":"Search by name for carriers with an official account as well as the carriers you added to your carrier list. The results are paginated with a limit of 20 entries per response.","tags":["carrier"],"security":[{"Authorization":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"search":{"type":"string"},"p":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["search"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["Carrier","Customer","Warehouse"]},"carrierType":{"anyOf":[{"type":"string","enum":["Brokerage","Asset","BrokerAsset"]},{"type":"null"}]},"status":{"type":"string","enum":["Active","Disabled","Invited"]},"country":{"type":"string","enum":["US","MX","CA"]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"name":{"type":"string"},"phoneNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"internalDistributionEmail":{"anyOf":[{"type":"string"},{"type":"null"}]},"website":{"anyOf":[{"type":"string"},{"type":"null"}]},"scac":{"anyOf":[{"type":"string"},{"type":"null"}]},"usdot":{"anyOf":[{"type":"string"},{"type":"null"}]},"mcNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"irc":{"anyOf":[{"type":"string"},{"type":"null"}]},"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"suite":{"anyOf":[{"type":"string"},{"type":"null"}]},"zipcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"string"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"string"},{"type":"null"}]},"timeZone":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"deletedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"logoUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailSignatureLogoUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdByOrganizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"originalId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","carrierType","status","country","id","name","phoneNumber","email","internalDistributionEmail","website","scac","usdot","mcNumber","irc","street","suite","zipcode","city","state","latitude","longitude","timeZone","createdAt","updatedAt","deletedAt","logoUrl","emailSignatureLogoUrl","note","createdByOrganizationId","originalId"],"additionalProperties":false}},"next":{"type":"object","properties":{"p":{"type":"number"}},"required":["p"],"additionalProperties":false},"previous":{"type":"object","properties":{"p":{"type":"number"}},"required":["p"],"additionalProperties":false},"limit":{"type":"number"},"totalPages":{"type":"number"},"totalRecords":{"type":"number"}},"required":["results","limit","totalPages","totalRecords"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}},"/customer":{"get":{"operationId":"customer-list","description":"Lists all the customers with an official account as well as the customers you added to your customer list","tags":["customer"],"security":[{"Authorization":[]}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["Carrier","Customer","Warehouse"]},"carrierType":{"anyOf":[{"type":"string","enum":["Brokerage","Asset","BrokerAsset"]},{"type":"null"}]},"status":{"type":"string","enum":["Active","Disabled","Invited"]},"country":{"type":"string","enum":["US","MX","CA"]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"name":{"type":"string"},"phoneNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"internalDistributionEmail":{"anyOf":[{"type":"string"},{"type":"null"}]},"website":{"anyOf":[{"type":"string"},{"type":"null"}]},"scac":{"anyOf":[{"type":"string"},{"type":"null"}]},"usdot":{"anyOf":[{"type":"string"},{"type":"null"}]},"mcNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"irc":{"anyOf":[{"type":"string"},{"type":"null"}]},"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"suite":{"anyOf":[{"type":"string"},{"type":"null"}]},"zipcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"string"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"string"},{"type":"null"}]},"timeZone":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"deletedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"logoUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailSignatureLogoUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdByOrganizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"originalId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","carrierType","status","country","id","name","phoneNumber","email","internalDistributionEmail","website","scac","usdot","mcNumber","irc","street","suite","zipcode","city","state","latitude","longitude","timeZone","createdAt","updatedAt","deletedAt","logoUrl","emailSignatureLogoUrl","note","createdByOrganizationId","originalId"],"additionalProperties":false}}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}},"post":{"operationId":"customer-create","description":"Creates a new customer","tags":["customer"],"security":[{"Authorization":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"phoneNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"website":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["Active","Disabled","Invited"]},{"type":"null"}]},"irc":{"anyOf":[{"type":"string"},{"type":"null"}]},"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"suite":{"anyOf":[{"type":"string"},{"type":"null"}]},"zipcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string","enum":["US","MX","CA"]},{"type":"null"}]},"timeZone":{"anyOf":[{"type":"string"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["Carrier","Customer","Warehouse"]},"carrierType":{"anyOf":[{"type":"string","enum":["Brokerage","Asset","BrokerAsset"]},{"type":"null"}]},"status":{"type":"string","enum":["Active","Disabled","Invited"]},"country":{"type":"string","enum":["US","MX","CA"]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"name":{"type":"string"},"phoneNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"internalDistributionEmail":{"anyOf":[{"type":"string"},{"type":"null"}]},"website":{"anyOf":[{"type":"string"},{"type":"null"}]},"scac":{"anyOf":[{"type":"string"},{"type":"null"}]},"usdot":{"anyOf":[{"type":"string"},{"type":"null"}]},"mcNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"irc":{"anyOf":[{"type":"string"},{"type":"null"}]},"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"suite":{"anyOf":[{"type":"string"},{"type":"null"}]},"zipcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"string"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"string"},{"type":"null"}]},"timeZone":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"deletedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"logoUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailSignatureLogoUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdByOrganizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"originalId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","carrierType","status","country","id","name","phoneNumber","email","internalDistributionEmail","website","scac","usdot","mcNumber","irc","street","suite","zipcode","city","state","latitude","longitude","timeZone","createdAt","updatedAt","deletedAt","logoUrl","emailSignatureLogoUrl","note","createdByOrganizationId","originalId"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}},"/customer/{customerId}":{"get":{"operationId":"customer-get","description":"Retrieves the details for a given customer organization","tags":["customer"],"security":[{"Authorization":[]}],"parameters":[{"in":"path","name":"customerId","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["Carrier","Customer","Warehouse"]},"carrierType":{"anyOf":[{"type":"string","enum":["Brokerage","Asset","BrokerAsset"]},{"type":"null"}]},"status":{"type":"string","enum":["Active","Disabled","Invited"]},"country":{"type":"string","enum":["US","MX","CA"]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"name":{"type":"string"},"phoneNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"internalDistributionEmail":{"anyOf":[{"type":"string"},{"type":"null"}]},"website":{"anyOf":[{"type":"string"},{"type":"null"}]},"scac":{"anyOf":[{"type":"string"},{"type":"null"}]},"usdot":{"anyOf":[{"type":"string"},{"type":"null"}]},"mcNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"irc":{"anyOf":[{"type":"string"},{"type":"null"}]},"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"suite":{"anyOf":[{"type":"string"},{"type":"null"}]},"zipcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"string"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"string"},{"type":"null"}]},"timeZone":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"deletedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"logoUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailSignatureLogoUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdByOrganizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"originalId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","carrierType","status","country","id","name","phoneNumber","email","internalDistributionEmail","website","scac","usdot","mcNumber","irc","street","suite","zipcode","city","state","latitude","longitude","timeZone","createdAt","updatedAt","deletedAt","logoUrl","emailSignatureLogoUrl","note","createdByOrganizationId","originalId"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.NOT_FOUND"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}},"/customer/search":{"post":{"operationId":"customer-search","description":"Search by name for customers with an official account as well as the customers you added to your customer list. The results are paginated with a limit of 20 entries per response.","tags":["customer"],"security":[{"Authorization":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"search":{"type":"string"},"p":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["search"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["Carrier","Customer","Warehouse"]},"carrierType":{"anyOf":[{"type":"string","enum":["Brokerage","Asset","BrokerAsset"]},{"type":"null"}]},"status":{"type":"string","enum":["Active","Disabled","Invited"]},"country":{"type":"string","enum":["US","MX","CA"]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"name":{"type":"string"},"phoneNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"internalDistributionEmail":{"anyOf":[{"type":"string"},{"type":"null"}]},"website":{"anyOf":[{"type":"string"},{"type":"null"}]},"scac":{"anyOf":[{"type":"string"},{"type":"null"}]},"usdot":{"anyOf":[{"type":"string"},{"type":"null"}]},"mcNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"irc":{"anyOf":[{"type":"string"},{"type":"null"}]},"street":{"anyOf":[{"type":"string"},{"type":"null"}]},"suite":{"anyOf":[{"type":"string"},{"type":"null"}]},"zipcode":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"anyOf":[{"type":"string"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"string"},{"type":"null"}]},"longitude":{"anyOf":[{"type":"string"},{"type":"null"}]},"timeZone":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"deletedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"logoUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailSignatureLogoUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdByOrganizationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"originalId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["type","carrierType","status","country","id","name","phoneNumber","email","internalDistributionEmail","website","scac","usdot","mcNumber","irc","street","suite","zipcode","city","state","latitude","longitude","timeZone","createdAt","updatedAt","deletedAt","logoUrl","emailSignatureLogoUrl","note","createdByOrganizationId","originalId"],"additionalProperties":false}},"next":{"type":"object","properties":{"p":{"type":"number"}},"required":["p"],"additionalProperties":false},"previous":{"type":"object","properties":{"p":{"type":"number"}},"required":["p"],"additionalProperties":false},"limit":{"type":"number"},"totalPages":{"type":"number"},"totalRecords":{"type":"number"}},"required":["results","limit","totalPages","totalRecords"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}},"/appointment-purchase-order/{appointmentPurchaseOrderId}":{"get":{"operationId":"appointmentPurchaseOrder-get","description":"Retrieves the details for a given purchase order","tags":["appointment-purchase-order"],"security":[{"Authorization":[]}],"parameters":[{"in":"path","name":"appointmentPurchaseOrderId","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"handlingType":{"anyOf":[{"type":"string","enum":["Pallet","Case","Floor","SlipSheet","Bale","Corrugated","Crate","Drum","Gaylord","Roll","Skid","Other"]},{"type":"null"}]},"packingType":{"anyOf":[{"type":"string","enum":["Case","Carton","Box","Bag","Drum","Bundle","Piece","Other"]},{"type":"null"}]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"appointmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"shipmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"poNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"handlingQuantity":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"packingQuantity":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"weightLbs":{},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"loadingAppointmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"unloadingAppointmentId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["handlingType","packingType","id","appointmentId","shipmentId","poNumber","handlingQuantity","packingQuantity","weightLbs","description","createdAt","updatedAt","loadingAppointmentId","unloadingAppointmentId"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.NOT_FOUND"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}},"delete":{"operationId":"appointmentPurchaseOrder-delete","description":"Deletes a purchase order for an appointment","tags":["appointment-purchase-order"],"security":[{"Authorization":[]}],"parameters":[{"in":"path","name":"appointmentPurchaseOrderId","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"handlingType":{"anyOf":[{"type":"string","enum":["Pallet","Case","Floor","SlipSheet","Bale","Corrugated","Crate","Drum","Gaylord","Roll","Skid","Other"]},{"type":"null"}]},"packingType":{"anyOf":[{"type":"string","enum":["Case","Carton","Box","Bag","Drum","Bundle","Piece","Other"]},{"type":"null"}]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"appointmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"shipmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"poNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"handlingQuantity":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"packingQuantity":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"weightLbs":{},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"loadingAppointmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"unloadingAppointmentId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["handlingType","packingType","id","appointmentId","shipmentId","poNumber","handlingQuantity","packingQuantity","weightLbs","description","createdAt","updatedAt","loadingAppointmentId","unloadingAppointmentId"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.NOT_FOUND"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}},"patch":{"operationId":"appointmentPurchaseOrder-update","description":"Updates a purchase order for an appointment","tags":["appointment-purchase-order"],"security":[{"Authorization":[]}],"parameters":[{"in":"path","name":"appointmentPurchaseOrderId","schema":{"type":"string"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"poNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"handlingType":{"anyOf":[{"type":"string","enum":["Pallet","Case","Floor","SlipSheet","Bale","Corrugated","Crate","Drum","Gaylord","Roll","Skid","Other"]},{"type":"null"}]},"handlingQuantity":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"packingType":{"anyOf":[{"type":"string","enum":["Case","Carton","Box","Bag","Drum","Bundle","Piece","Other"]},{"type":"null"}]},"packingQuantity":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"weightLbs":{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string"},{"type":"object","properties":{"d":{"type":"array","items":{"type":"number"}},"e":{"type":"number"},"s":{"type":"number"},"toFixed":{}},"required":["d","e","s","toFixed"]}]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"loadingAppointmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"unloadingAppointmentId":{"anyOf":[{"type":"string"},{"type":"null"}]}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"handlingType":{"anyOf":[{"type":"string","enum":["Pallet","Case","Floor","SlipSheet","Bale","Corrugated","Crate","Drum","Gaylord","Roll","Skid","Other"]},{"type":"null"}]},"packingType":{"anyOf":[{"type":"string","enum":["Case","Carton","Box","Bag","Drum","Bundle","Piece","Other"]},{"type":"null"}]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"appointmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"shipmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"poNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"handlingQuantity":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"packingQuantity":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"weightLbs":{},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"loadingAppointmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"unloadingAppointmentId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["handlingType","packingType","id","appointmentId","shipmentId","poNumber","handlingQuantity","packingQuantity","weightLbs","description","createdAt","updatedAt","loadingAppointmentId","unloadingAppointmentId"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.NOT_FOUND"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}},"/appointment-purchase-order":{"get":{"operationId":"appointmentPurchaseOrder-list","description":"Lists the purchase orders associated with an appointment","tags":["appointment-purchase-order"],"security":[{"Authorization":[]}],"parameters":[{"in":"query","name":"appointmentId","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"handlingType":{"anyOf":[{"type":"string","enum":["Pallet","Case","Floor","SlipSheet","Bale","Corrugated","Crate","Drum","Gaylord","Roll","Skid","Other"]},{"type":"null"}]},"packingType":{"anyOf":[{"type":"string","enum":["Case","Carton","Box","Bag","Drum","Bundle","Piece","Other"]},{"type":"null"}]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"appointmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"shipmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"poNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"handlingQuantity":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"packingQuantity":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"weightLbs":{},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"loadingAppointmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"unloadingAppointmentId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["handlingType","packingType","id","appointmentId","shipmentId","poNumber","handlingQuantity","packingQuantity","weightLbs","description","createdAt","updatedAt","loadingAppointmentId","unloadingAppointmentId"],"additionalProperties":false}}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.NOT_FOUND"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}},"post":{"operationId":"appointmentPurchaseOrder-create","description":"Creates a new purchase order for an appointment","tags":["appointment-purchase-order"],"security":[{"Authorization":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"shipmentId":{"type":"string"},"poNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"handlingType":{"anyOf":[{"type":"string","enum":["Pallet","Case","Floor","SlipSheet","Bale","Corrugated","Crate","Drum","Gaylord","Roll","Skid","Other"]},{"type":"null"}]},"handlingQuantity":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"packingType":{"anyOf":[{"type":"string","enum":["Case","Carton","Box","Bag","Drum","Bundle","Piece","Other"]},{"type":"null"}]},"packingQuantity":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"weightLbs":{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string"},{"type":"object","properties":{"d":{"type":"array","items":{"type":"number"}},"e":{"type":"number"},"s":{"type":"number"},"toFixed":{}},"required":["d","e","s","toFixed"]}]},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"loadingAppointmentNumber":{"description":"The stop number in sequence where this PO is loaded. Starts at 1.","anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"unloadingAppointmentNumber":{"description":"The stop number in sequence where this PO is unloaded. Starts at 1.","anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["shipmentId"]}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"handlingType":{"anyOf":[{"type":"string","enum":["Pallet","Case","Floor","SlipSheet","Bale","Corrugated","Crate","Drum","Gaylord","Roll","Skid","Other"]},{"type":"null"}]},"packingType":{"anyOf":[{"type":"string","enum":["Case","Carton","Box","Bag","Drum","Bundle","Piece","Other"]},{"type":"null"}]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"appointmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"shipmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"poNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"handlingQuantity":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"packingQuantity":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"weightLbs":{},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"loadingAppointmentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"unloadingAppointmentId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["handlingType","packingType","id","appointmentId","shipmentId","poNumber","handlingQuantity","packingQuantity","weightLbs","description","createdAt","updatedAt","loadingAppointmentId","unloadingAppointmentId"],"additionalProperties":false}}}},"400":{"description":"Invalid input data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.BAD_REQUEST"}}}},"401":{"description":"Authorization not provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.UNAUTHORIZED"}}}},"403":{"description":"Insufficient access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.FORBIDDEN"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.INTERNAL_SERVER_ERROR"}}}}}}}},"components":{"schemas":{"user":{"type":"object","properties":{"role":{"nullable":true,"type":"string","enum":["SuperAdmin","Admin","Member","Limited","ViewOnly","DistributionList"]},"status":{"nullable":true,"type":"string","enum":["Active","Disabled","Invited"]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"name":{"nullable":true,"type":"string"},"lastName":{"nullable":true,"type":"string"},"email":{"nullable":true,"type":"string"},"emailVerified":{"nullable":true,"type":"string","format":"date-time"},"image":{"nullable":true,"type":"string"},"phone":{"nullable":true,"type":"string"},"jobTitle":{"nullable":true,"type":"string"},"signature":{"type":"boolean"},"signatureImageUrl":{"nullable":true,"type":"string"},"signatureDisclaimer":{"nullable":true,"type":"string"},"organizationId":{"nullable":true,"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"nullable":true,"type":"string","format":"date-time"},"lastActiveAt":{"nullable":true,"type":"string","format":"date-time"}},"required":["role","status","id","name","lastName","email","emailVerified","image","phone","jobTitle","signature","signatureImageUrl","signatureDisclaimer","organizationId","createdAt","updatedAt","lastActiveAt"],"additionalProperties":false},"shipment":{"type":"object","properties":{"equipmentType":{"nullable":true,"type":"string","enum":["ET53V","ET48V","ET53R","ET48R","ET40C","ET20C","ET53F","ET48F","ETLiftGate"]},"temperature":{"nullable":true,"type":"string","enum":["Dry","Ambient","Fresh","Frozen","Cooler"]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"nullable":true,"type":"string","format":"date-time"},"organizationId":{"type":"string"},"customerId":{"nullable":true,"type":"string"},"carrierId":{"nullable":true,"type":"string"},"sealNumber":{"nullable":true,"type":"string"},"bolNumber":{"nullable":true,"type":"string"},"carrierLoadId":{"nullable":true,"type":"string"},"scac":{"nullable":true,"type":"string"},"distance":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"distanceOverride":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"shipDate":{"nullable":true,"type":"string","format":"date-time"},"dueDate":{"nullable":true,"type":"string","format":"date-time"},"externalShipmentId":{"nullable":true,"type":"string"},"isInfeasible":{"nullable":true,"type":"boolean"},"isInfeasibleNotified":{"nullable":true,"type":"boolean"},"originSourceId":{"nullable":true,"type":"string"}},"required":["equipmentType","temperature","id","createdAt","updatedAt","organizationId","customerId","carrierId","sealNumber","bolNumber","carrierLoadId","scac","distance","distanceOverride","shipDate","dueDate","externalShipmentId","isInfeasible","isInfeasibleNotified","originSourceId"],"additionalProperties":false},"appointment":{"type":"object","properties":{"status":{"type":"string","enum":["Started","Unscheduled","Draft","Pending","Scheduled","CheckedIn","AtDock","DroppedOff","ReadyForPickup","Canceled","Completed","Declined","Refused","OnHold","Expired","Rescheduled","NotApplicable"]},"unloadingType":{"type":"string","enum":["Live","Drop"]},"loadingType":{"nullable":true,"type":"string","enum":["Pallet","Case","Floor","SlipSheet","Bale","Corrugated","Crate","Drum","Gaylord","Roll","Skid","Other"]},"complianceStatus":{"nullable":true,"type":"string","enum":["OnTime","Late","Unplanned","Early","NoShow","LateWorkIn"]},"direction":{"type":"string","enum":["Inbound","Outbound"]},"priority":{"type":"string","enum":["High","Medium","None"]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"date":{"type":"string","format":"date-time"},"dateTz":{"nullable":true,"type":"string","format":"date-time"},"detention":{"type":"boolean"},"ftl":{"type":"boolean"},"duration":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"palletCount":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"description":{"nullable":true,"type":"string"},"rejectionReason":{"nullable":true,"type":"string"},"dueDate":{"nullable":true,"type":"string","format":"date-time"},"targetDate":{"nullable":true,"type":"string","format":"date-time"},"targetDateEnd":{"nullable":true,"type":"string","format":"date-time"},"overflow":{"type":"boolean"},"requestedDateEnd":{"nullable":true,"type":"string","format":"date-time"},"stopNumber":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"scheduledTimeRangeEnd":{"nullable":true,"type":"string","format":"date-time"},"timeNotNeeded":{"type":"boolean"},"dateEnd":{"nullable":true,"type":"string","format":"date-time"},"externalId":{"nullable":true,"type":"string"},"confirmationNumber":{"nullable":true,"type":"string"},"originSourceId":{"nullable":true,"type":"string"},"lumper":{"nullable":true,"type":"boolean"},"facilityId":{"type":"string"},"dockId":{"nullable":true,"type":"string"},"dropLocationId":{"nullable":true,"type":"string"},"holdingOrganizationId":{"nullable":true,"type":"string"},"organizationId":{"nullable":true,"type":"string"},"rescheduledByUserId":{"nullable":true,"type":"string"},"createdByUserId":{"type":"string"},"sentByUserId":{"nullable":true,"type":"string"},"proposedByUserId":{"nullable":true,"type":"string"},"parentId":{"nullable":true,"type":"string"},"trailerNumber":{"nullable":true,"type":"string"},"truckIdentifier":{"nullable":true,"type":"string"},"driverName":{"nullable":true,"type":"string"},"driverPhone":{"nullable":true,"type":"string"},"selfCheckedIn":{"type":"boolean"},"scheduledAt":{"nullable":true,"type":"string","format":"date-time"},"checkedInAt":{"nullable":true,"type":"string","format":"date-time"},"atDockAt":{"nullable":true,"type":"string","format":"date-time"},"droppedOffAt":{"nullable":true,"type":"string","format":"date-time"},"readyForPickupAt":{"nullable":true,"type":"string","format":"date-time"},"completedAt":{"nullable":true,"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"nullable":true,"type":"string","format":"date-time"},"lastRequestSentAt":{"nullable":true,"type":"string","format":"date-time"},"firstScheduledAt":{"nullable":true,"type":"string","format":"date-time"},"arrivedAt":{"nullable":true,"type":"string","format":"date-time"},"departedAt":{"nullable":true,"type":"string","format":"date-time"},"shipmentId":{"type":"string"},"wmsNumber":{"nullable":true,"type":"string"},"orderNumber":{"nullable":true,"type":"string"},"referenceNumber":{"nullable":true,"type":"string"},"resentCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"recurringAppointmentId":{"nullable":true,"type":"string"},"schedulingMethodId":{"nullable":true,"type":"string"},"rescheduleCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["status","unloadingType","loadingType","complianceStatus","direction","priority","id","date","dateTz","detention","ftl","duration","palletCount","description","rejectionReason","dueDate","targetDate","targetDateEnd","overflow","requestedDateEnd","stopNumber","scheduledTimeRangeEnd","timeNotNeeded","dateEnd","externalId","confirmationNumber","originSourceId","lumper","facilityId","dockId","dropLocationId","holdingOrganizationId","organizationId","rescheduledByUserId","createdByUserId","sentByUserId","proposedByUserId","parentId","trailerNumber","truckIdentifier","driverName","driverPhone","selfCheckedIn","scheduledAt","checkedInAt","atDockAt","droppedOffAt","readyForPickupAt","completedAt","createdAt","updatedAt","lastRequestSentAt","firstScheduledAt","arrivedAt","departedAt","shipmentId","wmsNumber","orderNumber","referenceNumber","resentCount","recurringAppointmentId","schedulingMethodId","rescheduleCount"],"additionalProperties":false},"comment":{"type":"object","properties":{"autoCategory":{"nullable":true,"type":"string","enum":["Cancel","Refuse","Reschedule","Request","ReadyForPickup"]},"detailedCategory":{"nullable":true,"type":"string","enum":["ETAUpdateAsked","ETAUpdateGiven","ResponsePositiveWithDate","ResponsePositiveWithoutDate","ResponseNegativeWithDate","ResponseNegativeWithoutDate","Comment","Reschedule","Decline","Hold","Refuse"]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"subject":{"nullable":true,"type":"string"},"body":{"type":"string"},"cc":{"nullable":true,"type":"string"},"to":{"nullable":true,"type":"string"},"abbreviated":{"nullable":true,"type":"string"},"appointmentId":{"nullable":true,"type":"string"},"userId":{"nullable":true,"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"nullable":true,"type":"string","format":"date-time"},"bulkNotifyId":{"nullable":true,"type":"string"},"isEmail":{"type":"boolean"},"messageId":{"nullable":true,"type":"string"},"inReplyTo":{"nullable":true,"type":"string"},"references":{"nullable":true,"type":"string"},"fullHTMLFileData":{"nullable":true,"allOf":[{"$ref":"#/definitions/__schema0"}]},"strippedHTML":{"nullable":true,"type":"string"},"fullText":{"nullable":true,"type":"string"},"strippedText":{"nullable":true,"type":"string"}},"required":["autoCategory","detailedCategory","id","subject","body","cc","to","abbreviated","appointmentId","userId","createdAt","updatedAt","bulkNotifyId","isEmail","messageId","inReplyTo","references","fullHTMLFileData","strippedHTML","fullText","strippedText"],"additionalProperties":false,"definitions":{"__schema0":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null","enum":[null]},{"type":"object","additionalProperties":{"allOf":[{"$ref":"#/definitions/__schema0"}]}},{"type":"array","items":{"allOf":[{"$ref":"#/definitions/__schema0"}]}}]}}},"carrier":{"type":"object","properties":{"type":{"type":"string","enum":["Carrier","Customer","Warehouse"]},"carrierType":{"nullable":true,"type":"string","enum":["Brokerage","Asset","BrokerAsset"]},"status":{"type":"string","enum":["Active","Disabled","Invited"]},"country":{"type":"string","enum":["US","MX","CA"]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"name":{"type":"string"},"phoneNumber":{"nullable":true,"type":"string"},"email":{"nullable":true,"type":"string"},"internalDistributionEmail":{"nullable":true,"type":"string"},"website":{"nullable":true,"type":"string"},"scac":{"nullable":true,"type":"string"},"usdot":{"nullable":true,"type":"string"},"mcNumber":{"nullable":true,"type":"string"},"irc":{"nullable":true,"type":"string"},"street":{"nullable":true,"type":"string"},"suite":{"nullable":true,"type":"string"},"zipcode":{"nullable":true,"type":"string"},"city":{"nullable":true,"type":"string"},"state":{"nullable":true,"type":"string"},"latitude":{"nullable":true,"type":"string"},"longitude":{"nullable":true,"type":"string"},"timeZone":{"nullable":true,"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"nullable":true,"type":"string","format":"date-time"},"deletedAt":{"nullable":true,"type":"string","format":"date-time"},"logoUrl":{"nullable":true,"type":"string"},"emailSignatureLogoUrl":{"nullable":true,"type":"string"},"note":{"nullable":true,"type":"string"},"createdByOrganizationId":{"nullable":true,"type":"string"},"originalId":{"nullable":true,"type":"string"}},"required":["type","carrierType","status","country","id","name","phoneNumber","email","internalDistributionEmail","website","scac","usdot","mcNumber","irc","street","suite","zipcode","city","state","latitude","longitude","timeZone","createdAt","updatedAt","deletedAt","logoUrl","emailSignatureLogoUrl","note","createdByOrganizationId","originalId"],"additionalProperties":false},"customer":{"type":"object","properties":{"type":{"type":"string","enum":["Carrier","Customer","Warehouse"]},"carrierType":{"nullable":true,"type":"string","enum":["Brokerage","Asset","BrokerAsset"]},"status":{"type":"string","enum":["Active","Disabled","Invited"]},"country":{"type":"string","enum":["US","MX","CA"]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"name":{"type":"string"},"phoneNumber":{"nullable":true,"type":"string"},"email":{"nullable":true,"type":"string"},"internalDistributionEmail":{"nullable":true,"type":"string"},"website":{"nullable":true,"type":"string"},"scac":{"nullable":true,"type":"string"},"usdot":{"nullable":true,"type":"string"},"mcNumber":{"nullable":true,"type":"string"},"irc":{"nullable":true,"type":"string"},"street":{"nullable":true,"type":"string"},"suite":{"nullable":true,"type":"string"},"zipcode":{"nullable":true,"type":"string"},"city":{"nullable":true,"type":"string"},"state":{"nullable":true,"type":"string"},"latitude":{"nullable":true,"type":"string"},"longitude":{"nullable":true,"type":"string"},"timeZone":{"nullable":true,"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"nullable":true,"type":"string","format":"date-time"},"deletedAt":{"nullable":true,"type":"string","format":"date-time"},"logoUrl":{"nullable":true,"type":"string"},"emailSignatureLogoUrl":{"nullable":true,"type":"string"},"note":{"nullable":true,"type":"string"},"createdByOrganizationId":{"nullable":true,"type":"string"},"originalId":{"nullable":true,"type":"string"}},"required":["type","carrierType","status","country","id","name","phoneNumber","email","internalDistributionEmail","website","scac","usdot","mcNumber","irc","street","suite","zipcode","city","state","latitude","longitude","timeZone","createdAt","updatedAt","deletedAt","logoUrl","emailSignatureLogoUrl","note","createdByOrganizationId","originalId"],"additionalProperties":false},"facility":{"type":"object","properties":{"status":{"type":"string","enum":["Operational","ClosedTemporarily","ClosedPermanently"]},"type":{"type":"string","enum":["Verified","External","Internal"]},"country":{"type":"string","enum":["US","MX","CA"]},"schedulingType":{"nullable":true,"type":"string","enum":["Appointment","FirstComeFirstServe"]},"id":{"type":"string","format":"cuid","pattern":"^[cC][^\\s-]{8,}$"},"name":{"type":"string"},"phoneNumber":{"nullable":true,"type":"string"},"email":{"nullable":true,"type":"string"},"irc":{"nullable":true,"type":"string"},"deleted":{"nullable":true,"type":"string","format":"date-time"},"street":{"type":"string"},"suite":{"nullable":true,"type":"string"},"zipcode":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"latitude":{"type":"string"},"longitude":{"type":"string"},"timeZone":{"type":"string"},"deprecated":{"type":"boolean"},"organizationId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"nullable":true,"type":"string","format":"date-time"},"amenities":{"nullable":true,"type":"string"},"cutOffTime":{"type":"string","format":"date-time"},"schedulingDaysAheadMin":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"schedulingDaysAheadMax":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"allowSameDayReschedule":{"type":"boolean"},"notes":{"nullable":true,"type":"string"},"selfCheckIn":{"type":"boolean"},"placeKeyId":{"nullable":true,"type":"string"},"requiredFields":{"nullable":true,"allOf":[{"$ref":"#/definitions/__schema0"}]},"thirdPartyId":{"nullable":true,"type":"string"},"originalId":{"nullable":true,"type":"string"},"autoConfirmAppointments":{"type":"boolean"},"reasonCodesEnabled":{"type":"boolean"}},"required":["status","type","country","schedulingType","id","name","phoneNumber","email","irc","deleted","street","suite","zipcode","city","state","latitude","longitude","timeZone","deprecated","organizationId","createdAt","updatedAt","amenities","cutOffTime","schedulingDaysAheadMin","schedulingDaysAheadMax","allowSameDayReschedule","notes","selfCheckIn","placeKeyId","requiredFields","thirdPartyId","originalId","autoConfirmAppointments","reasonCodesEnabled"],"additionalProperties":false,"definitions":{"__schema0":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null","enum":[null]},{"type":"object","additionalProperties":{"allOf":[{"$ref":"#/definitions/__schema0"}]}},{"type":"array","items":{"allOf":[{"$ref":"#/definitions/__schema0"}]}}]}}}},"securitySchemes":{"apiKey":{"type":"apiKey","name":"apiKey","in":"header"},"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}}}