--- updatedAt: 2025-04-24T20:28:03.000Z agentTools: projectIndex: https://api-docs.shippedsuite.com/llms.txt --- # /v1/green_offers Calculates Green fee for a given order subtotal # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "Shipped Suite API", "description": "API provides access to Shipped Suite functions", "contact": { "name": "Steven Ou", "email": "steven@invisiblecommerce.com" }, "version": "v1" }, "servers": [ { "url": "//api.shippedsuite.com/" } ], "security": [ { "secretKey": [] } ], "tags": [ { "name": "Offers", "description": "Operations about Shield and Green Offers" } ], "paths": { "/v1/green_offers": { "post": { "tags": [ "Offers" ], "description": "Calculates Green fee for a given order subtotal", "operationId": "postV1GreenOffers", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postV1GreenOffers" } } }, "required": true }, "responses": { "201": { "description": "Calculates Green fee for a given order subtotal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GreenOffer" } } } } }, "security": [ { "publicOrSecretKey": [] } ], "x-codegen-request-body-name": "postV1GreenOffers" } } }, "components": { "schemas": { "Money": { "required": [ "currency", "formatted", "subunits" ], "type": "object", "properties": { "currency": { "type": "object", "description": "Currency", "allOf": [ { "$ref": "#/components/schemas/Currency" } ] }, "subunits": { "type": "integer", "description": "The value in the currency's smallest unit", "format": "int32", "example": 4000 }, "formatted": { "type": "string", "description": "Formatted representation", "example": "€40,00" } } }, "Currency": { "required": [ "decimal_mark", "iso_code", "name", "subunit_to_unit", "symbol", "symbol_first", "thousands_separator" ], "type": "object", "properties": { "decimal_mark": { "type": "string", "description": "Symbol use to separate decimals", "example": "." }, "symbol": { "type": "number", "description": "Currency symbol" }, "symbol_first": { "type": "boolean", "description": "Whether to display the symbol before or after the number", "example": true }, "thousands_separator": { "type": "string", "description": "Symbol used to separate each thousand units", "example": "," }, "subunit_to_unit": { "type": "integer", "description": "The number of subunits to a unit", "format": "int32", "example": 100 }, "iso_code": { "type": "string", "description": "The ISO code for the Currency", "example": "USD" }, "name": { "type": "string", "description": "The full name of the Currency", "example": "USD" } }, "description": "Currency model" }, "postV1GreenOffers": { "required": [ "order_value" ], "type": "object", "properties": { "order_value": { "type": "number", "description": "The order value to calculate an Offer for. This should be the subtotal of the items, excluding any discount, promotion, shipping, taxes, etc.',", "format": "double", "example": 129.99 }, "currency": { "type": "string", "description": "The display currency the order value is in.", "example": "JPY", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SKK", "SLE", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "YER", "ZAR", "ZMK", "ZMW", "BCH", "BTC", "JEP", "GGP", "IMP", "XFU", "GBX", "CNH", "USDC", "EEK", "GHS", "HRK", "LTL", "LVL", "MRO", "MTL", "TMM", "JPY", "ZWD", "ZWL", "ZWN", "ZWR", "VEF" ] }, "exchange_rate": { "type": "number", "description": "The exchange rate used between the storefront default currency and the order display currency.", "format": "double", "example": 146.23807692 } }, "description": "Calculates Green fee for a given order subtotal" }, "GreenOffer": { "required": [ "complimentary", "green_fee", "green_fee_with_currency", "mandatory", "offered_at", "order_value", "storefront_name", "storefront_subdomain" ], "type": "object", "properties": { "storefront_subdomain": { "type": "string", "description": "Storefront Subdomain the Green Offer is valid for", "example": "ic-development" }, "storefront_name": { "type": "string", "description": "Name of Storefront the Offer is valid for", "example": "IC Development" }, "order_value": { "type": "number", "description": "The value of the order Green Offer is valid for", "example": 129.99 }, "green_fee": { "type": "number", "description": "The Green Fee associated with this Green Offer", "example": 1.81986 }, "green_fee_with_currency": { "type": "object", "description": "The Green Fee associated with this Green Offer, with currency information", "allOf": [ { "$ref": "#/components/schemas/Money" } ] }, "offered_at": { "type": "string", "description": "The date and time the Green Offer was generated. RFC 3339. ", "format": "date-time" }, "mandatory": { "type": "boolean", "description": "Whether or not the offer is mandatory (widget-enforced)." }, "complimentary": { "type": "boolean", "description": "Whether or not the offer is complimentary (isInformational on widget)." } }, "description": "GreenOffer model" } }, "securitySchemes": { "publicOrSecretKey": { "type": "apiKey", "name": "Authorization", "in": "header" }, "secretKey": { "type": "apiKey", "name": "Authorization", "in": "header" } } }, "x-original-swagger-version": "2.0" } ```