Medusa

Add to Shipping Options

POST

/admin/tax-rates/{id}/shipping-options/batch

Tax Rates

Associates a Tax Rate with a list of Shipping Options.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST '{{BASE_URL}}/admin/tax-rates//shipping-options/batch' \
--header 'Content-Type: application/json' \
--data-raw '{
    "shipping_options": [
        "string"
    ]
}'

Response Example

200 - Example 1

{
    "tax_rate": {
        "id": "txr_01G8XDBAWKBHHJRKH0AV02KXBR",
        "rate": 10,
        "code": "tax01",
        "name": "Tax Example",
        "region_id": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G",
        "region": {},
        "product_count": 10,
        "product_type_count": 2,
        "shipping_option_count": 1,
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "metadata": {
            "car": "white"
        },
        "product_types": [
            {
                "id": "ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A",
                "value": "Clothing",
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "deleted_at": "2019-08-24T14:15:22Z",
                "metadata": {
                    "car": "white"
                }
            }
        ],
        "shipping_options": [
            {
                "id": "so_01G1G5V27GYX4QXNARRQCW1N8T",
                "name": "PostFake Standard",
                "region_id": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G",
                "region": {},
                "profile_id": "sp_01G1G5V239ENSZ5MV4JAR737BM",
                "provider_id": "manual",
                "amount": 200,
                "is_return": false,
                "admin_only": false,
                "includes_tax": false,
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "deleted_at": "2019-08-24T14:15:22Z",
                "price_type": "flat_rate",
                "data": {},
                "metadata": {
                    "car": "white"
                },
                "provider": {
                    "id": "manual",
                    "is_installed": true
                },
                "requirements": [
                    {
                        "id": "sor_01G1G5V29AB4CTNDRFSRWSRKWD",
                        "shipping_option_id": "so_01G1G5V27GYX4QXNARRQCW1N8T",
                        "shipping_option": {},
                        "amount": 100,
                        "deleted_at": "2019-08-24T14:15:22Z",
                        "type": "min_subtotal"
                    }
                ],
                "profile": {
                    "id": "sp_01G1G5V239ENSZ5MV4JAR737BM",
                    "name": "Default Shipping Profile",
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "deleted_at": "2019-08-24T14:15:22Z",
                    "type": "default",
                    "products": [
                        {}
                    ],
                    "shipping_options": [
                        {}
                    ],
                    "metadata": {
                        "car": "white"
                    }
                }
            }
        ],
        "products": [
            {
                "id": "prod_01G1G5V2MBA328390B5AXJ610F",
                "title": "Medusa Coffee Mug",
                "subtitle": "string",
                "description": "Every programmer's best friend.",
                "handle": "coffee-mug",
                "is_giftcard": false,
                "thumbnail": "http://example.com",
                "profile_id": "sp_01G1G5V239ENSZ5MV4JAR737BM",
                "weight": null,
                "length": null,
                "height": null,
                "width": null,
                "hs_code": null,
                "origin_country": null,
                "mid_code": null,
                "material": null,
                "collection_id": "pcol_01F0YESBFAZ0DV6V831JXWH0BG",
                "type_id": "ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A",
                "discountable": true,
                "external_id": null,
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "deleted_at": "2019-08-24T14:15:22Z",
                "status": "draft",
                "metadata": {
                    "car": "white"
                },
                "images": [
                    {
                        "id": "img_01G749BFYR6T8JTVW6SGW3K3E6",
                        "url": "http://example.com",
                        "created_at": "2019-08-24T14:15:22Z",
                        "updated_at": "2019-08-24T14:15:22Z",
                        "deleted_at": "2019-08-24T14:15:22Z",
                        "metadata": {
                            "car": "white"
                        }
                    }
                ],
                "categories": [
                    {
                        "id": "pcat_01G2SG30J8C85S4A5CHM2S1NS2",
                        "name": "Regular Fit",
                        "handle": "regular-fit",
                        "mpath": "pcat_id1.pcat_id2.pcat_id3",
                        "is_internal": false,
                        "is_active": false,
                        "rank": 0,
                        "parent_category_id": null,
                        "parent_category": {},
                        "created_at": "2019-08-24T14:15:22Z",
                        "updated_at": "2019-08-24T14:15:22Z",
                        "category_children": [
                            {}
                        ],
                        "products": [
                            {}
                        ]
                    }
                ],
                "collection": {
                    "id": "pcol_01F0YESBFAZ0DV6V831JXWH0BG",
                    "title": "Summer Collection",
                    "handle": "summer-collection",
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "deleted_at": "2019-08-24T14:15:22Z",
                    "products": [
                        {}
                    ],
                    "metadata": {
                        "car": "white"
                    }
                },
                "tags": [
                    {
                        "id": "ptag_01G8K2MTMG9168F2B70S1TAVK3",
                        "value": "Pants",
                        "created_at": "2019-08-24T14:15:22Z",
                        "updated_at": "2019-08-24T14:15:22Z",
                        "deleted_at": "2019-08-24T14:15:22Z",
                        "metadata": {
                            "car": "white"
                        }
                    }
                ],
                "profile": {
                    "id": "sp_01G1G5V239ENSZ5MV4JAR737BM",
                    "name": "Default Shipping Profile",
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "deleted_at": "2019-08-24T14:15:22Z",
                    "type": "default",
                    "products": [
                        {}
                    ],
                    "shipping_options": [
                        {}
                    ],
                    "metadata": {
                        "car": "white"
                    }
                },
                "profiles": [
                    {
                        "id": "sp_01G1G5V239ENSZ5MV4JAR737BM",
                        "name": "Default Shipping Profile",
                        "created_at": "2019-08-24T14:15:22Z",
                        "updated_at": "2019-08-24T14:15:22Z",
                        "deleted_at": "2019-08-24T14:15:22Z",
                        "type": "default",
                        "products": [
                            {}
                        ],
                        "shipping_options": [
                            {}
                        ],
                        "metadata": {
                            "car": "white"
                        }
                    }
                ],
                "type": {
                    "id": "ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A",
                    "value": "Clothing",
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "deleted_at": "2019-08-24T14:15:22Z",
                    "metadata": {
                        "car": "white"
                    }
                },
                "sales_channels": [
                    {
                        "id": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A",
                        "name": "Market",
                        "description": "Multi-vendor market",
                        "is_disabled": false,
                        "created_at": "2019-08-24T14:15:22Z",
                        "updated_at": "2019-08-24T14:15:22Z",
                        "deleted_at": "2019-08-24T14:15:22Z",
                        "metadata": {
                            "car": "white"
                        },
                        "locations": [
                            {
                                "id": "scloc_01G8X9A7ESKAJXG2H0E6F1MW7A",
                                "sales_channel_id": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A",
                                "location_id": "string",
                                "sales_channel": {},
                                "created_at": "2019-08-24T14:15:22Z",
                                "updated_at": "2019-08-24T14:15:22Z",
                                "deleted_at": "2019-08-24T14:15:22Z"
                            }
                        ]
                    }
                ],
                "options": [
                    {
                        "id": "opt_01F0YESHQBZVKCEXJ24BS6PCX3",
                        "title": "Size",
                        "product_id": "prod_01G1G5V2MBA328390B5AXJ610F",
                        "product": {},
                        "created_at": "2019-08-24T14:15:22Z",
                        "updated_at": "2019-08-24T14:15:22Z",
                        "deleted_at": "2019-08-24T14:15:22Z",
                        "metadata": {
                            "car": "white"
                        },
                        "values": [
                            {
                                "id": "optval_01F0YESHR7S6ECD03RF6W12DSJ",
                                "value": "large",
                                "option_id": "opt_01F0YESHQBZVKCEXJ24BS6PCX3",
                                "option": {},
                                "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
                                "variant": {},
                                "created_at": "2019-08-24T14:15:22Z",
                                "updated_at": "2019-08-24T14:15:22Z",
                                "deleted_at": "2019-08-24T14:15:22Z",
                                "metadata": {
                                    "car": "white"
                                }
                            }
                        ]
                    }
                ],
                "variants": [
                    {
                        "id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
                        "title": "Small",
                        "product_id": "prod_01G1G5V2MBA328390B5AXJ610F",
                        "product": {},
                        "sku": "shirt-123",
                        "barcode": null,
                        "ean": null,
                        "upc": null,
                        "variant_rank": 0,
                        "inventory_quantity": 100,
                        "allow_backorder": false,
                        "manage_inventory": true,
                        "hs_code": null,
                        "origin_country": null,
                        "mid_code": null,
                        "material": null,
                        "weight": null,
                        "length": null,
                        "height": null,
                        "width": null,
                        "created_at": "2019-08-24T14:15:22Z",
                        "updated_at": "2019-08-24T14:15:22Z",
                        "deleted_at": "2019-08-24T14:15:22Z",
                        "purchasable": true,
                        "metadata": {
                            "car": "white"
                        },
                        "options": [
                            {
                                "id": "optval_01F0YESHR7S6ECD03RF6W12DSJ",
                                "value": "large",
                                "option_id": "opt_01F0YESHQBZVKCEXJ24BS6PCX3",
                                "option": {},
                                "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
                                "variant": {},
                                "created_at": "2019-08-24T14:15:22Z",
                                "updated_at": "2019-08-24T14:15:22Z",
                                "deleted_at": "2019-08-24T14:15:22Z",
                                "metadata": {
                                    "car": "white"
                                }
                            }
                        ],
                        "inventory_items": [
                            {
                                "id": "pvitem_01G8X9A7ESKAJXG2H0E6F1MW7A",
                                "inventory_item_id": "string",
                                "variant_id": "string",
                                "variant": {},
                                "required_quantity": 1,
                                "created_at": "2019-08-24T14:15:22Z",
                                "updated_at": "2019-08-24T14:15:22Z",
                                "deleted_at": "2019-08-24T14:15:22Z"
                            }
                        ],
                        "prices": [
                            {
                                "id": "ma_01F0YESHRFQNH5S8Q0PK84YYZN",
                                "amount": 100,
                                "min_quantity": 1,
                                "max_quantity": 1,
                                "price_list_id": "pl_01G8X3CKJXCG5VXVZ87H9KC09W",
                                "price_list": {},
                                "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6",
                                "variant": {},
                                "region_id": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G",
                                "region": {},
                                "created_at": "2019-08-24T14:15:22Z",
                                "updated_at": "2019-08-24T14:15:22Z",
                                "deleted_at": "2019-08-24T14:15:22Z",
                                "currency_code": "usd",
                                "currency": {
                                    "symbol": "$",
                                    "symbol_native": "$",
                                    "name": "US Dollar",
                                    "includes_tax": false,
                                    "code": "usd"
                                }
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

Request

Path Params

string

required

ID of the tax rate.

Query Params

fields

array[string]

optional

Comma-separated fields that should be included in the returned tax rate.

expand

array[string]

optional

Comma-separated relations that should be expanded in the returned tax rate.

Body Params application/json

shipping_options

array[string]

required

The IDs of the shipping options to associate with this tax rate

Examples

Responses

🟢200OK

application/json

Body

tax_rate

object (Tax Rate)

required

A Tax Rate can be used to define a custom rate to charge on specified products, product types, and shipping options within a given region.

string

required

The tax rate's ID

Example:

txr_01G8XDBAWKBHHJRKH0AV02KXBR

rate

number | null

required

The numeric rate to charge

Example:

code

string | null

required

A code to identify the tax type by

Example:

tax01

name

string

required

A human friendly name for the tax

Example:

Tax Example

region_id

string

required

The ID of the region that the rate belongs to.

Example:

reg_01G1G5V26T9H8Y0M4JNE3YGA4G

region

object | null

optional

The details of the region that the rate belongs to.

product_count

integer

optional

The count of products

Example:

product_type_count

integer

optional

The count of product types

Example:

shipping_option_count

integer

optional

The count of shipping options

Example:

created_at

string <date-time>

required

The date with timezone at which the resource was created.

updated_at

string <date-time>

required

The date with timezone at which the resource was updated.

metadata

object | null

required

An optional key-value map with additional details

Example:

{"car":"white"}

product_types

array[object (Product Type) {6}]

optional

The details of the product types that belong to this tax rate.

shipping_options

array[object (Shipping Option) {19}]

optional

The details of the shipping options that belong to this tax rate.

products

array[object (Product) {35}]

optional

The details of the products that belong to this tax rate.

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error

Protected File Upload

Remove Shipping Options from Rate