{
 "openapi": "3.1.0",
 "info": {
  "title": "Logistics Providers (Supply Chain)",
  "version": "20261030b",
  "description": "The integrations the platform knows how to speak, and what each one actually needs before it will work. \"Configure your credentials\" helps nobody."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "logistics-providers": {
    "type": "object",
    "required": [
     "code",
     "name"
    ],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "org_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org id",
      "readOnly": true
     },
     "code": {
      "type": "string",
      "description": "Code"
     },
     "name": {
      "type": "string",
      "description": "Name"
     },
     "vendor": {
      "type": "string",
      "description": "Vendor"
     },
     "category": {
      "type": "string",
      "description": "Category",
      "enum": [
       "parcel",
       "ltl",
       "truckload",
       "ocean",
       "air",
       "forwarder",
       "aggregator",
       "postal",
       "last_mile",
       "visibility",
       "customs"
      ]
     },
     "supports_rating": {
      "type": "boolean",
      "description": "Can rate"
     },
     "supports_booking": {
      "type": "boolean",
      "description": "Can book"
     },
     "supports_labels": {
      "type": "boolean",
      "description": "Can produce labels"
     },
     "supports_tracking": {
      "type": "boolean",
      "description": "Can track"
     },
     "supports_pickup": {
      "type": "boolean",
      "description": "Can arrange collection"
     },
     "supports_documents": {
      "type": "boolean",
      "description": "Can produce documents"
     },
     "supports_webhooks": {
      "type": "boolean",
      "description": "Pushes events back"
     },
     "protocol": {
      "type": "string",
      "description": "Protocol",
      "enum": [
       "rest",
       "soap",
       "edi",
       "ftp",
       "sftp",
       "email",
       "manual"
      ]
     },
     "auth_method": {
      "type": "string",
      "description": "Authentication",
      "enum": [
       "oauth2",
       "api_key",
       "basic",
       "certificate",
       "token",
       "none"
      ]
     },
     "base_url": {
      "type": "string",
      "description": "Production URL"
     },
     "sandbox_url": {
      "type": "string",
      "description": "Sandbox URL"
     },
     "edi_standard": {
      "type": "string",
      "description": "EDI standard"
     },
     "label_formats": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Label formats",
      "readOnly": true
     },
     "tracking_url_template": {
      "type": "string",
      "description": "Tracking URL template"
     },
     "documentation_url": {
      "type": "string",
      "description": "Documentation"
     },
     "setup_notes": {
      "type": "string",
      "description": "What has to be got first"
     },
     "is_active": {
      "type": "boolean",
      "description": "Active"
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Created at",
      "readOnly": true
     },
     "org_unit_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org unit id",
      "readOnly": true
     },
     "xf_text_1": {
      "type": "string",
      "description": "Xf text 1",
      "readOnly": true
     },
     "xf_text_2": {
      "type": "string",
      "description": "Xf text 2",
      "readOnly": true
     },
     "xf_text_3": {
      "type": "string",
      "description": "Xf text 3",
      "readOnly": true
     },
     "xf_text_4": {
      "type": "string",
      "description": "Xf text 4",
      "readOnly": true
     },
     "xf_text_5": {
      "type": "string",
      "description": "Xf text 5",
      "readOnly": true
     },
     "xf_num_1": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 1",
      "readOnly": true
     },
     "xf_num_2": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 2",
      "readOnly": true
     },
     "xf_num_3": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 3",
      "readOnly": true
     },
     "xf_date_1": {
      "type": "string",
      "format": "date",
      "description": "Xf date 1",
      "readOnly": true
     },
     "xf_date_2": {
      "type": "string",
      "format": "date",
      "description": "Xf date 2",
      "readOnly": true
     },
     "created_by": {
      "type": "string",
      "format": "uuid",
      "description": "Created by",
      "readOnly": true
     },
     "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Updated at",
      "readOnly": true
     },
     "updated_by": {
      "type": "string",
      "format": "uuid",
      "description": "Updated by",
      "readOnly": true
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/scm/logistics-providers": {
   "get": {
    "summary": "list logistics-providers",
    "operationId": "list_logistics_providers_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create logistics-providers",
    "operationId": "create_logistics_providers_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/scm/logistics-providers/{id}": {
   "get": {
    "summary": "get logistics-providers",
    "operationId": "get_logistics_providers_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change logistics-providers",
    "operationId": "change_logistics_providers_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete logistics-providers",
    "operationId": "delete_logistics_providers_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/scm/logistics-providers/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_logistics_providers_0_6",
    "description": "Body keys: overrides, preview, withLines",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  }
 }
}