# Shippings

## GET /shippings/shipping-options/

> This method returns details about a specific shipping option, including its ID, delivery type, name, slug, and active status. It also includes the shipping option’s associated sorting order, calculator, rule (with its name and slug), and any additional information in the form of attributes like descriptions and logos

```json
{"openapi":"3.0.3","info":{"title":"Data Warehouse","version":"1.0.0"},"servers":[{"description":"Server base URL with dynamic channel_id.","url":"https://{omnitron_url}/api/v1/remote/{channel_id}/data-warehouse","variables":{"channel_id":{"default":"1","description":"Unique identifier for the sales channel."},"omnitron_url":{"default":"sandbox.akinon.com"}}},{"description":"Server base URL with Commerce URL.","url":"https://{commerce_url}/api/v1/data-warehouse","variables":{"commerce_url":{"default":"sandbox.commerce.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"description":"Token-based authentication with required prefix \"Token\"","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"PaginatedShippingOptionList":{"properties":{"count":{"description":"Numerical value representing quantity or total amount.","type":"integer"},"next":{"description":"This field defines the URL of the next page.","format":"uri","nullable":true,"type":"string"},"previous":{"description":"This field defines the URL of the previous page.","format":"uri","nullable":true,"type":"string"},"results":{"description":"This field returns a list of results.","items":{"$ref":"#/components/schemas/ShippingOption"},"type":"array"}},"type":"object"},"ShippingOption":{"properties":{"calculator":{"description":"The field defines the rule used to calculate the price of the shipping option."},"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"delivery_type":{"$ref":"#/components/schemas/DeliveryTypeEnum","description":"The classification or type related to this field."},"description":{"description":"Detailed explanation or information about this field.","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the record.","type":"integer"},"is_active":{"description":"Boolean flag indicating whether the condition is met.","type":"boolean"},"kwargs":{"description":"The field defines any additional parameters for the shipping option."},"logo":{"description":"The field defines the logo associated with the shipping option.","format":"uri","nullable":true,"type":"string"},"modified_date":{"description":"This field defines the last updated date.","format":"date-time","type":"string"},"name":{"description":"The full name or label associated with the record.","maxLength":128,"type":"string"},"rule":{"description":"The field defines the rule that determines under which conditions the shipping option can be selected."},"slug":{"description":"The field defines the slug of the shipping option.","maxLength":128,"pattern":"^[-a-zA-Z0-9_]+$","type":"string"},"sort_order":{"description":"The field defines the sort order of the shipping option.","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"translations":{"description":"This field defines the translations of the district name.","nullable":true}},"type":"object"},"DeliveryTypeEnum":{"description":"* `same_day` - Same Day Delivery\n* `next_day` - Next Day Delivery\n* `standard` - Standard Delivery\n* `in_store` - In-store Delivery","enum":["same_day","next_day","standard","in_store"],"type":"string"}}},"paths":{"/shippings/shipping-options/":{"get":{"description":"This method returns details about a specific shipping option, including its ID, delivery type, name, slug, and active status. It also includes the shipping option’s associated sorting order, calculator, rule (with its name and slug), and any additional information in the form of attributes like descriptions and logos","operationId":"shippings_shipping_options_list","parameters":[{"description":"Query parameter `calculator` used to filter results based on specific conditions.","in":"query","name":"calculator","schema":{}},{"description":"Query parameter `created_date` used to filter results based on specific conditions.","in":"query","name":"created_date","schema":{"format":"date-time","type":"string"}},{"description":"Query parameter `delivery_type` used to filter results based on specific conditions.","in":"query","name":"delivery_type","schema":{"type":"string"}},{"description":"Query parameter `description` used to filter results based on specific conditions.","in":"query","name":"description","schema":{"type":"string"}},{"description":"Query parameter `id` used to filter results based on specific conditions.","in":"query","name":"id","schema":{"type":"integer"}},{"description":"Filters records where `id` is greater than the given value.","in":"query","name":"id__gt","schema":{"type":"integer"}},{"description":"Filters records where `id` is greater than or equal to the given value.","in":"query","name":"id__gte","schema":{"type":"integer"}},{"description":"Filters records where `id` is less than the given value.","in":"query","name":"id__lt","schema":{"type":"integer"}},{"description":"Filters records where `id` is less than or equal to the given value.","in":"query","name":"id__lte","schema":{"type":"integer"}},{"description":"Query parameter `is_active` used to filter results based on specific conditions.","in":"query","name":"is_active","schema":{"type":"boolean"}},{"description":"Query parameter `kwargs` used to filter results based on specific conditions.","in":"query","name":"kwargs","schema":{}},{"description":"Limits the number of results returned in the response.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Query parameter `logo` used to filter results based on specific conditions.","in":"query","name":"logo","schema":{"type":"string"}},{"description":"Query parameter `modified_date` used to filter results based on specific conditions.","in":"query","name":"modified_date","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is greater than the given value.","in":"query","name":"modified_date__gt","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is greater than or equal to the given value.","in":"query","name":"modified_date__gte","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is less than the given value.","in":"query","name":"modified_date__lt","schema":{"format":"date-time","type":"string"}},{"description":"Filters records where `modified_date` is less than or equal to the given value.","in":"query","name":"modified_date__lte","schema":{"format":"date-time","type":"string"}},{"description":"Query parameter `name` used to filter results based on specific conditions.","in":"query","name":"name","schema":{"type":"string"}},{"description":"Query parameter `page` used to filter results based on specific conditions.","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Query parameter `rule` used to filter results based on specific conditions.","in":"query","name":"rule","schema":{}},{"description":"Query parameter `slug` used to filter results based on specific conditions.","in":"query","name":"slug","schema":{"type":"string"}},{"description":"Query parameter `sort` used to filter results based on specific conditions.","in":"query","name":"sort","required":false,"schema":{"type":"string"}},{"description":"Query parameter `sort_order` used to filter results based on specific conditions.","in":"query","name":"sort_order","schema":{"type":"integer"}},{"description":"Query parameter `translations` used to filter results based on specific conditions.","in":"query","name":"translations","schema":{"nullable":true}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedShippingOptionList"}}},"description":"Successful response for status code 200."}},"tags":["shippings"]}}}}
```

## GET /shippings/shipping-options/{id}/

> This method returns details about a specific shipping option, including its ID, delivery type, name, slug, and active status. It also includes the shipping option’s associated sorting order, calculator, rule (with its name and slug), and any additional information in the form of attributes like descriptions and logos This endpoint retrieves a specific record by its unique identifier.

```json
{"openapi":"3.0.3","info":{"title":"Data Warehouse","version":"1.0.0"},"servers":[{"description":"Server base URL with dynamic channel_id.","url":"https://{omnitron_url}/api/v1/remote/{channel_id}/data-warehouse","variables":{"channel_id":{"default":"1","description":"Unique identifier for the sales channel."},"omnitron_url":{"default":"sandbox.akinon.com"}}},{"description":"Server base URL with Commerce URL.","url":"https://{commerce_url}/api/v1/data-warehouse","variables":{"commerce_url":{"default":"sandbox.commerce.akinon.com"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"description":"Token-based authentication with required prefix \"Token\"","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"ShippingOption":{"properties":{"calculator":{"description":"The field defines the rule used to calculate the price of the shipping option."},"created_date":{"description":"Timestamp indicating when the record was created.","format":"date-time","type":"string"},"delivery_type":{"$ref":"#/components/schemas/DeliveryTypeEnum","description":"The classification or type related to this field."},"description":{"description":"Detailed explanation or information about this field.","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the record.","type":"integer"},"is_active":{"description":"Boolean flag indicating whether the condition is met.","type":"boolean"},"kwargs":{"description":"The field defines any additional parameters for the shipping option."},"logo":{"description":"The field defines the logo associated with the shipping option.","format":"uri","nullable":true,"type":"string"},"modified_date":{"description":"This field defines the last updated date.","format":"date-time","type":"string"},"name":{"description":"The full name or label associated with the record.","maxLength":128,"type":"string"},"rule":{"description":"The field defines the rule that determines under which conditions the shipping option can be selected."},"slug":{"description":"The field defines the slug of the shipping option.","maxLength":128,"pattern":"^[-a-zA-Z0-9_]+$","type":"string"},"sort_order":{"description":"The field defines the sort order of the shipping option.","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"translations":{"description":"This field defines the translations of the district name.","nullable":true}},"type":"object"},"DeliveryTypeEnum":{"description":"* `same_day` - Same Day Delivery\n* `next_day` - Next Day Delivery\n* `standard` - Standard Delivery\n* `in_store` - In-store Delivery","enum":["same_day","next_day","standard","in_store"],"type":"string"}}},"paths":{"/shippings/shipping-options/{id}/":{"get":{"description":"This method returns details about a specific shipping option, including its ID, delivery type, name, slug, and active status. It also includes the shipping option’s associated sorting order, calculator, rule (with its name and slug), and any additional information in the form of attributes like descriptions and logos This endpoint retrieves a specific record by its unique identifier.","operationId":"shippings_shipping_options_retrieve","parameters":[{"description":"A unique integer value identifying this shipping option.","in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShippingOption"}}},"description":"Successful response for status code 200."},"404":{"content":{"application/json":{}},"description":"Object not found."}},"tags":["shippings"]}}}}
```