delivery.carrier: fields, relations and API
The delivery.carrier model ("Delivery Method") is a persistent model declared by the Delivery Costs module, then extended by 5 other modules. It exposes 52 fields, 46 of them declared directly on the model; 11 fields from other models point to it. Below you will find every field with its technical name, type, label and relations, followed by an Odoo 20 JSON-2 API call.
Model identity
- Technical name
delivery.carrier- Label
- Delivery Method
- Type
- Persistent (models.Model)
- SQL table
delivery_carrier- Origin module
- Delivery Costs (
delivery) - Extended by
- stock_delivery, sale_gelato, website_sale, website_sale_stock, website_sale_collect
- Default order (_order)
sequence, id- Inherits from (mixins)
website.published.multi.mixin
Model fields
46 own fields, 0 inherited from mixins and 6 automatic ORM fields. Click a name to get a direct link to that field.
52 of 52 fields shown
| Technical name | Label | Type | Details |
|---|---|---|---|
| active | Active | boolean | |
| allow_cash_on_delivery | Cash on Delivery Allow customers to choose Cash on Delivery as their payment method. | boolean | |
| amount | Amount Amount of the order to benefit from a free shipping, expressed in the company currency. | float | |
| can_generate_return | Can Generate Return | boolean | computed |
| carrier_description | Description A description of the delivery method that you want to communicate to your customers on the Sales Order and sales confirmation email. E.g. instructions for customers to follow. | text | translatable |
| company_id | Company | many2one | related: |
| country_ids | Countries | many2many | |
| currency_id | Currency | many2one | related: |
| debug_logging | Debug logging Log requests in order to ease debugging | boolean | |
| delivery_calendar_id | Delivery Calendar | many2one | added by eCommerce ( |
| delivery_cost | Cost | monetary | read-onlycomputed |
| delivery_currency_id | Delivery Currency | many2one | computed |
| delivery_estimate_lead_days | Delivery Estimate Lead Days | integer | added by eCommerce ( |
| delivery_estimate_range_days | Delivery Estimate Range Days | integer | added by eCommerce ( |
| delivery_type | Provider | selection | required Values: |
| enable_delivery_estimate | Estimated Delivery Display estimated date to your customer. Editable if range is defined. | boolean | added by eCommerce ( |
| excluded_tag_ids | Excluded Tags The method is NOT available if at least one product of the order has one of these tags. | many2many | |
| fixed_margin | Fixed Margin This fixed amount will be added to the shipping price. | float | |
| fixed_price | Fixed Price | float | computed, stored |
| free_over | Free if order amount is above If the order total amount (shipping excluded) is above or equal to this value, the customer benefits from a free shipping. | boolean | |
| gelato_shipping_service_type | Gelato Shipping Service Type | selection | required Values: added by Gelato ( |
| get_return_label_from_portal | Return Label Accessible from Customer Portal The return label can be downloaded by the customer from the customer portal. | boolean | |
| integration_level | Integration Level Action while validating Delivery Orders. | selection | Values: |
| invoice_policy | Invoicing Policy Estimated Cost: the customer will be invoiced the estimated cost of the shipping. Real Cost: the customer will be invoiced the real cost of the shipping, the cost of theshipping will be updated on the SO after the delivery. | selection | required Values: |
| margin | Margin This percentage will be added to the shipping price. | float | |
| max_volume | Max Volume If the total volume of the order is over this volume, the method won't be available. | float | |
| max_weight | Max Weight If the total weight of the order is over this weight, the method won't be available. | float | |
| must_have_tag_ids | Must Have Tags The method is available only if at least one product of the order has one of these tags. | many2many | |
| name | Delivery Method | char | requiredtranslatable |
| price_rule_ids | Pricing Rules | one2many | inverse: |
| prod_environment | Environment Set to True if your credentials are certified for production. | boolean | |
| product_id | Delivery Product | many2one | required |
| return_label_on_delivery | Generate Return Label The return label is automatically generated at the delivery. | boolean | |
| route_ids | Routes | many2many | added by Delivery - Stock ( |
| sequence | Sequence Determine the display order | integer | |
| shipping_insurance | Insurance Percentage Shipping insurance is a service which may reimburse senders whose parcels are lost, stolen, and/or damaged in transit. | integer | |
| state_ids | States | many2many | |
| support_pickup_locations | Support Pickup Locations | boolean | computed added by Product Availability ( |
| supports_cash_on_delivery | Supports Cash On Delivery | boolean | computed |
| supports_shipping_insurance | Supports Shipping Insurance | boolean | computed |
| tracking_url | Tracking Link This option adds a link for the customer in the portal to track their package easily. Use <shipmenttrackingnumber> as a placeholder in your URL. | char | |
| volume_uom_name | Volume unit of measure label | char | computed |
| warehouse_ids | Stores | many2many | added by Click & Collect ( |
| website_description | Description for Online Quotations | text | related: added by eCommerce ( |
| weight_uom_name | Weight unit of measure label | char | computed |
| zip_prefix_ids | Zip Prefixes Prefixes of zip codes that this delivery method applies to. Note that regular expressions can be used to support countries with varying zip code lengths, i.e. '$' can be added to end of prefix to match the exact zip (e.g. '100$' will only match '100' and not '1000') | many2many | |
| create_date | Created on | datetime | read-onlyautomatic |
| create_uid | Created by | many2one | read-onlyautomatic |
| display_name | Display Name | char | read-onlycomputedautomatic |
| id | ID | integer | read-onlyautomatic |
| write_date | Last Updated on | datetime | read-onlyautomatic |
| write_uid | Last Updated by | many2one | read-onlyautomatic |
Relations
Models linked from this model
- delivery.price.rule: price_rule_ids
- delivery.zip.prefix: zip_prefix_ids
- product.product: product_id
- product.tag: excluded_tag_ids, must_have_tag_ids
- res.company: company_id
- res.country: country_ids
- res.country.state: state_ids
- res.currency: currency_id, delivery_currency_id
- resource.calendar: delivery_calendar_id
- stock.route: route_ids
- stock.warehouse: warehouse_ids
Fields of other models pointing here
- choose.delivery.carrier: available_carrier_ids, carrier_id
- delivery.note.wizard: dm_id
- delivery.price.rule: carrier_id
- res.partner: pickup_delivery_method_id, property_delivery_carrier_id
- sale.order: carrier_id
- stock.move.line: carrier_id
- stock.picking: allowed_carrier_ids, carrier_id
- website: in_store_dm_id
Reading this model through the API
Odoo 20 JSON-2 API call reading the first five records with real fields of the model. Replace the instance, database and API key with your own.
curl -X POST "https://your-instance.odoo.com/json/2/delivery.carrier/search_read" \
-H "Authorization: bearer $ODOO_API_KEY" \
-H "X-Odoo-Database: your-db" \
-H "Content-Type: application/json" \
-d '{"domain":[],"fields":["name","delivery_type","gelato_shipping_service_type","invoice_policy","product_id"],"limit":5}'import requests
BASE_URL = "https://your-instance.odoo.com/json/2"
headers = {"Authorization": f"bearer {API_KEY}", "X-Odoo-Database": "your-db"}
res = requests.post(
f"{BASE_URL}/delivery.carrier/search_read",
headers=headers,
json={"domain": [], "fields": ["name","delivery_type","gelato_shipping_service_type","invoice_policy","product_id"], "limit": 5},
)
res.raise_for_status()
print(res.json())- External API access requires Odoo's Custom plan.
- XML-RPC and JSON-RPC will be removed in Odoo 22 (fall 2028): use JSON-2.
- The access rights and record rules of the key's user apply.
Cite this tool
Writing a tutorial, internal documentation or a forum answer? Copy this link to send your readers to the up-to-date reference.
<a href="https://aidoo.ai/en/outils/explorateur-modeles-odoo/delivery-carrier">delivery.carrier (Odoo 20.0)</a>Sources
Data verified on September 25, 2026 · Odoo 20.0 Community
Have an Odoo project, or want to put your ERP to work with AI? Let's talk
Implementation, custom module development, connecting Claude or ChatGPT to your data: tell us about your context and we will reply within 24 business hours.