{"method":"GET","path":"https://api.revcent.com/v2/shipping_profiles/{shipping_profile_id}","summary":"Get A Shipping Profile","description":"Retrieve the details of a specific Shipping Profile. View markdown documentation at https://revcent.com/documentation/markdown/mcp/operation/OverviewShippingProfile.md for an in-depth overview of this operation.","operationId":"GetShippingProfile","parameters":[{"in":"path","name":"shipping_profile_id","description":"The Shipping Profile ID.","required":true,"schema":{"type":"string","description":"A 20 character shipping profile ID.","minLength":20,"maxLength":20}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"additionalProperties":false,"properties":{},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"description":"","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time"},"code":{"description":"The API call response code, 1 = Success","type":"integer","enum":[1]}},"title":"APICallResponseInfo","type":"object","additionalProperties":false},{"type":"object","description":"A shipping profile defines the settings for calculating shipping rates.","additionalProperties":false,"properties":{"created_date_unix":{"description":"The unix timestamp of when the item was created.","type":"integer","format":"unix-time"},"id":{"type":"string","description":"A 20 character shipping profile ID.","minLength":20,"maxLength":20},"name":{"description":"The shipping profile name.","type":"string"},"description":{"description":"The shipping profile description.","type":"string"},"enabled":{"description":"Whether the shipping profile is currently enabled.","type":"boolean"},"rates":{"type":"array","description":"An array of shipping rates for the shipping profile.","items":{"type":"object","additionalProperties":false,"properties":{"rate":{"description":"The shipping rate amount. This is what the customer will be charged for shipping.","type":"number","format":"float"},"provider":{"type":"string","description":"A 20 character site shipping provider ID.","minLength":20,"maxLength":20},"provider_method":{"type":"string","description":"A 20 character site shipping provider method ID.","minLength":20,"maxLength":20},"qualifiers":{"type":"object","description":"Qualifiers are used to determine if a shipping rate applies to a transaction based on settings such as product, product group, country and revenue rules.<br><br>Important: There must be at least one enabled qualifier for the shipping rate, within either 'products', 'product_groups', 'countries' or 'revenue_rules'. A shipping rate cannot contain zero enabled qualifiers.","additionalProperties":false,"properties":{"products":{"description":"An array of product objects, in which products associated with the shipment must match at least one of the product objects to qualify for the shipping rate. Leave empty to not require product qualification.","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"id":{"title":"Product ID","type":"string","description":"A 20 character product ID.","minLength":20,"maxLength":20},"enabled":{"description":"Whether the individual product qualifier is enabled.","type":"boolean"},"quantity_rule":{"description":"The quantity rule to apply for the individual product qualifier.","type":"string","enum":["any","equal_to","greater_than","greater_than_equal_to","less_than","less_than_equal_to"]},"quantity_value":{"description":"The quantity value to apply for the individual product qualifier. This is used in conjunction with the quantity rule to determine if the individual product qualifier passes or fails. For example, if the quantity rule is 'equal_to', then the quantity value is used to determine if the individual product qualifier passes or fails. If the quantity rule is 'any', then the quantity value is not used.","type":"integer"}},"required":["id","enabled","quantity_rule","quantity_value"]}},"product_groups":{"description":"An array of product group objects, in which products associated with the shipment must match at least one of the product group objects to qualify for the shipping rate. Leave empty to not require product group qualification.","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","description":"A 20 character product group ID.","minLength":20,"maxLength":20},"enabled":{"description":"Whether the individual product group qualifier is enabled.","type":"boolean"}},"required":["id","enabled"]}},"countries":{"description":"An array of country objects that qualify for the shipping rate. The shipment destination country must match at least one of the enabled country codes in the array to qualify for the shipping rate. Leave empty to apply to all countries.","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"iso_code":{"type":"string","description":"The ISO3 country code."},"enabled":{"description":"Whether the individual country qualifier is enabled.","type":"boolean"}},"required":["iso_code","enabled"]}},"revenue_rules":{"type":"array","description":"Revenue rules are specific to the shipping profile, and allow or disallow the use of the shipping rate based on revenue settings. You can add multiple revenue rules to a shipping rate. Leave empty to not require revenue rule qualification.","items":{"type":"object","additionalProperties":false,"properties":{"enabled":{"description":"Whether the individual revenue rule is enabled.","type":"boolean"},"source":{"description":"The source value, either the total amount of the associated purchase, the transaction amount of the associated purchase, or the total amount for shippable products in the transaction. This is used in combination with the rule and rule_value to determine if the rule passes or fails.","type":"string","enum":["total_amount","transaction_amount","shippable_products"]},"rule":{"description":"The rule bounds to declare if a rule passes or fails.","type":"string","enum":["equal_to","greater_than","greater_than_equal_to","less_than","less_than_equal_to"]},"rule_value":{"description":"The rule_value is compared to the source value using the specified rule to determine if the rule passes or fails.","type":"number","format":"float"}},"required":["enabled","source","rule","rule_value"]}}}}},"required":["rate","provider","provider_method","qualifiers"]}},"updated_date_unix":{"description":"The unix timestamp of when the item was last updated.","type":"integer","format":"unix-time"}}}]}}},"description":"Successful response."},"default":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time"},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","enum":[0]},"error_code":{"description":"The specific error code.","type":"string"},"message":{"description":"A human readable description of the error.","type":"string"},"result":{"description":"A description of the API call result.","type":"string"}},"title":"APIStandardErrors","type":"object","additionalProperties":false}}},"description":"Error response."}}}