- categories/{categoryId}
- store/storeGroups
- categories/{categoryId}/move
- store/storeViews
- categories/{categoryId}/products
- store/websites
- categories/{categoryId}/products/{sku}
- taxClasses
- {classId}
- {taxClassId}
- search
- taxClassesPOST
- categories/{id}
- taxClasses/search
- cmsBlock
- taxClasses/{classId}
- cmsBlock/search
- taxClasses/{taxClassId}
- cmsBlock/{blockId}
- taxRates
- cmsBlock/{id}
- taxRates/search
- cmsPage
- taxRates/{rateId}
- cmsPage/search
- taxRules
- cmsPage/{id}
- taxRules/search
- cmsPage/{pageId}
- taxRules/{ruleId}
- company/
- team/
- company/assignRoles
- team/{companyId}
- company/role/
- team/{teamId}
- company/role/{id}
- temando/rma/{rmaId}/shipments
- company/role/{roleId}
- transactions
- addresses
- company/role/{roleId}/users
- transactions/{id}
- company/{companyId}
- worldpay-guest-carts/{cartId}/payment-information
- companyCredits/
- companyCredits/company/{companyId}
- companyCredits/history
- companyCredits/history/{historyId}
- companyCredits/{creditId}
- companyCredits/{creditId}/decreaseBalance
- companyCredits/{creditId}/increaseBalance
- companyCredits/{id}
- configurable-products/variation
- configurable-products/{sku}/child
- configurable-products/{sku}/children
- configurable-products/{sku}/children/{childSku}
- configurable-products/{sku}/options
- configurable-products/{sku}/options/all
- configurable-products/{sku}/options/{id}
- coupons
- coupons/deleteByCodes
- coupons/deleteByIds
- coupons/generate
- coupons/search
- coupons/{couponId}
- creditmemo
- creditmemo/refund
- creditmemo/{id}
- creditmemo/{id}/comments
- creditmemo/{id}/emails
- creditmemos
- customerGroups
- customerGroups/default
- customerGroups/default/{id}
- customerGroups/default/{storeId}
- customerGroups/search
- customerGroups/{id}
- customerGroups/{id}/permissions
- customers
- customers/addresses/{addressId}
- customers/confirm
- customers/isEmailAvailable
- customers/me
- customers/me/activate
- customers/me/billingAddress
- customers/me/password
- customers/me/shippingAddress
- customers/password
- customers/resetPassword
- customers/search
- customers/validate
- customers/{customerId}
- customers/{customerId}/billingAddress
- customers/{customerId}/carts
- customers/{customerId}/confirm
- customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}
- customers/{customerId}/permissions/readonly
- customers/{customerId}/shippingAddress
- customers/{email}/activate
- directory/countries
- directory/countries/{countryId}
- directory/currency
- eav/attribute-sets
- eav/attribute-sets/list
- eav/attribute-sets/{attributeSetId}
- gift-wrappings
- gift-wrappings/{id}
- gift-wrappings/{wrappingId}
- giftregistry/mine/estimate-shipping-methods
- guest-carts
- guest-carts/{cartId}
- guest-carts/{cartId}/billing-address
- guest-carts/{cartId}/checkout-fields
- guest-carts/{cartId}/collect-totals
- guest-carts/{cartId}/collection-point/search-request
- guest-carts/{cartId}/collection-point/search-result
- guest-carts/{cartId}/collection-point/select
- guest-carts/{cartId}/coupons
- guest-carts/{cartId}/coupons/{couponCode}
- guest-carts/{cartId}/delivery-option
- guest-carts/{cartId}/estimate-shipping-methods
- guest-carts/{cartId}/gift-message
- guest-carts/{cartId}/gift-message/{itemId}
- guest-carts/{cartId}/items
- guest-carts/{cartId}/items/{itemId}
- guest-carts/{cartId}/order
- guest-carts/{cartId}/payment-information
- guest-carts/{cartId}/payment-methods
- guest-carts/{cartId}/selected-payment-method
- guest-carts/{cartId}/set-payment-information
- guest-carts/{cartId}/shipping-information
- guest-carts/{cartId}/shipping-methods
- guest-carts/{cartId}/totals
- guest-carts/{cartId}/totals-information
- guest-giftregistry/{cartId}/estimate-shipping-methods
- hierarchy/move/{id}
- hierarchy/{id}
- integration/admin/token
- integration/customer/token
- invoice/{invoiceId}/refund
- invoices
- invoices/
- invoices/comments
- invoices/{id}
- invoices/{id}/capture
- invoices/{id}/comments
- invoices/{id}/emails
- invoices/{id}/void
- modules
- negotiable-carts/{cartId}/billing-address
- negotiable-carts/{cartId}/coupons
- negotiable-carts/{cartId}/coupons/{couponCode}
- negotiable-carts/{cartId}/estimate-shipping-methods
- negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id
- negotiable-carts/{cartId}/giftCards
- negotiable-carts/{cartId}/giftCards/{giftCardCode}
- negotiable-carts/{cartId}/payment-information
- negotiable-carts/{cartId}/set-payment-information
- negotiable-carts/{cartId}/shipping-information
- negotiable-carts/{cartId}/totals
- negotiableQuote/attachmentContent
- negotiableQuote/decline
- negotiableQuote/pricesUpdated
- negotiableQuote/request
- negotiableQuote/submitToCustomer
- negotiableQuote/{quoteId}
- negotiableQuote/{quoteId}/comments
- negotiableQuote/{quoteId}/shippingMethod
- order/{orderId}/invoice
- order/{orderId}/refund
- order/{orderId}/ship
- orders
- orders/
- orders/create
- orders/items
- orders/items/{id}
- orders/{id}
- orders/{id}/cancel
- orders/{id}/comments
- orders/{id}/emails
- orders/{id}/hold
- orders/{id}/statuses
- orders/{id}/unhold
- orders/{parent_id}
- products
- products-render-info
- products/attribute-sets
- products/attribute-sets/attributes
- products/attribute-sets/groups
- products/attribute-sets/groups/list
- products/attribute-sets/groups/{groupId}
- products/attribute-sets/sets/list
- products/attribute-sets/{attributeSetId}
- addresses/{addressId}
- products/attribute-sets/{attributeSetId}/attributes
- amazon-billing-address/{amazonOrderReferenceId}
- products/attribute-sets/{attributeSetId}/attributes/{attributeCode}
- amazon-shipping-address/{amazonOrderReferenceId}
- products/attribute-sets/{attributeSetId}/groups
- amazon/order-ref
- products/attributes
- analytics/link
- products/attributes/types
- attributeMetadata/customer
- products/attributes/{attributeCode}
- attributeMetadata/customer/attribute/{attributeCode}
- products/attributes/{attributeCode}/options
- attributeMetadata/customer/custom
- products/attributes/{attributeCode}/options/{optionId}
- attributeMetadata/customer/form/{formCode}
- products/base-prices
- attributeMetadata/customerAddress
- products/base-prices-information
- attributeMetadata/customerAddress/attribute/{attributeCode}
- products/cost
- attributeMetadata/customerAddress/custom
- products/cost-delete
- attributeMetadata/customerAddress/form/{formCode}
- products/cost-information
- bulk/{bulkUuid}/detailed-status
- products/downloadable-links/samples/{id}
- bulk/{bulkUuid}/operation-status/{status}
- products/downloadable-links/{id}
- bulk/{bulkUuid}/status
- products/links/types
- bundle-products/options/add
- products/links/{type}/attributes
- bundle-products/options/types
- products/media/types/{attributeSetName}
- bundle-products/options/{optionId}
- products/options
- bundle-products/{productSku}/children
- products/options/types
- bundle-products/{sku}/links/{id}
- products/options/{optionId}
- bundle-products/{sku}/links/{optionId}
- products/special-price
- bundle-products/{sku}/options/all
- products/special-price-delete
- bundle-products/{sku}/options/{optionId}
- products/special-price-information
- bundle-products/{sku}/options/{optionId}/children/{childSku}
- products/tier-prices
- carts/
- products/tier-prices-delete
- carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}
- products/tier-prices-information
- carts/guest-carts/{cartId}/giftCards
- products/types
- carts/guest-carts/{cartId}/giftCards/{giftCardCode}
- products/{productSku}/stockItems/{itemId}
- carts/licence
- products/{sku}
- carts/mine
- products/{sku}/downloadable-links
- carts/mine/balance/apply
- products/{sku}/downloadable-links/samples
- carts/mine/balance/unapply
- products/{sku}/downloadable-links/samples/{id}
- carts/mine/billing-address
- products/{sku}/downloadable-links/{id}
- carts/mine/checkGiftCard/{giftCardCode}
- products/{sku}/group-prices/{customerGroupId}/tiers
- carts/mine/checkout-fields
- products/{sku}/group-prices/{customerGroupId}/tiers/{qty}
- carts/mine/collect-totals
- products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}
- carts/mine/collection-point/search-request
- products/{sku}/links
- carts/mine/collection-point/search-result
- products/{sku}/links/{type}
- carts/mine/collection-point/select
- products/{sku}/links/{type}/{linkedProductSku}
- carts/mine/coupons
- products/{sku}/media
- carts/mine/coupons/{couponCode}
- products/{sku}/media/{entryId}
- carts/mine/delivery-option
- products/{sku}/options
- carts/mine/estimate-shipping-methods
- products/{sku}/options/{optionId}
- carts/mine/estimate-shipping-methods-by-address-id
- products/{sku}/websites
- carts/mine/gift-message
- products/{sku}/websites/{websiteId}
- carts/mine/gift-message/{itemId}
- requisition_lists
- carts/mine/giftCards
- returns
- carts/mine/giftCards/{giftCardCode}
- returns/{id}
- carts/mine/items
- returns/{id}/comments
- carts/mine/items/{itemId}
- returns/{id}/labels
- carts/mine/order
- returns/{id}/tracking-numbers
- carts/mine/payment-information
- returns/{id}/tracking-numbers/{trackId}
- carts/mine/payment-methods
- returnsAttributeMetadata
- carts/mine/selected-payment-method
- returnsAttributeMetadata/custom
- carts/mine/set-payment-information
- returnsAttributeMetadata/form/{formCode}
- carts/mine/shipping-information
- returnsAttributeMetadata/{attributeCode}
- carts/mine/shipping-methods
- reward/mine/use-reward
- carts/mine/totals
- salesRules
- carts/mine/totals-information
- salesRules/search
- carts/search
- salesRules/{ruleId}
- carts/{cartId}
- search
- carts/{cartId}/billing-address
- sharedCatalog
- carts/{cartId}/coupons
- sharedCatalog/
- carts/{cartId}/coupons/{couponCode}
- sharedCatalog/{id}
- carts/{cartId}/estimate-shipping-methods
- sharedCatalog/{id}/assignCategories
- carts/{cartId}/estimate-shipping-methods-by-address-id
- sharedCatalog/{id}/assignProducts
- carts/{cartId}/gift-message
- sharedCatalog/{id}/categories
- carts/{cartId}/gift-message/{itemId}
- sharedCatalog/{id}/products
- carts/{cartId}/giftCards
- sharedCatalog/{id}/unassignCategories
- carts/{cartId}/giftCards/{giftCardCode}
- sharedCatalog/{id}/unassignProducts
- carts/{cartId}/items
- sharedCatalog/{sharedCatalogId}
- carts/{cartId}/items/{itemId}
- sharedCatalog/{sharedCatalogId}/assignCompanies
- carts/{cartId}/order
- sharedCatalog/{sharedCatalogId}/companies
- carts/{cartId}/payment-methods
- sharedCatalog/{sharedCatalogId}/unassignCompanies
- carts/{cartId}/selected-payment-method
- shipment/
- carts/{cartId}/shipping-information
- shipment/track
- carts/{cartId}/shipping-methods
- shipment/track/{id}
- carts/{cartId}/totals
- shipment/{id}
- carts/{cartId}/totals-information
- shipment/{id}/comments
- carts/{quoteId}/giftCards
- shipment/{id}/emails
- carts/{quoteId}/items
- shipment/{id}/label
- categories
- shipments
- categories/attributes
- stockItems/lowStock/
- categories/attributes/{attributeCode}
- stockItems/{productSku}
- categories/attributes/{attributeCode}/options
- stockStatuses/{productSku}
- categories/list
- store/storeConfigs
- amazon-billing-address
- amazon-shipping-address
- amazon
- analytics
- attributeMetadata
- bulk
- bundle-products
- carts
- 默认分组
- guest-carts
- licence
- mine
- balance
- billing-address
- checkGiftCard
- checkout-fields
- collect-totals
- collection-point
- coupons
- delivery-option
- estimate-shipping-methods
- estimate-shipping-methods-by-address-id
- gift-message
- giftCards
- items
- order
- payment-information
- payment-methods
- selected-payment-method
- set-payment-information
- shipping-information
- shipping-methods
- totals
- totals-information
- search
- {cartId}
- {quoteId}
- 默认目录
- company
- companyCredits
- configurable-products
- directory
- eav
- giftregistry
- guest-giftregistry
- hierarchy
- integration
- invoice
- negotiable-carts
- negotiableQuote
- order
- reward
- shipment
- stockItems
- stockStatuses
- store
- team
- temando
- worldpay-guest-carts
coupons/{couponId}
GET
/V1/coupons/{couponId}
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'http:///V1/coupons/'响应示例响应示例
200 - 示例 1
{
"code": "string",
"coupon_id": 0,
"created_at": "string",
"expiration_date": "string",
"extension_attributes": {},
"is_primary": true,
"rule_id": 0,
"times_used": 0,
"type": 0,
"usage_limit": 0,
"usage_per_customer": 0
}请求参数
Path 参数
couponId
integer
必需
返回响应
🟢200成功
application/json
Body
Interface CouponInterface
code
string
可选
coupon_id
integer
Coupon id
created_at
string
可选
expiration_date
string
可选
extension_attributes
object (sales-rule-data-coupon-extension-interface)
可选
is_primary
boolean
必需
rule_id
integer
必需
times_used
integer
必需
type
integer
Of coupon
usage_limit
integer
可选
usage_per_customer
integer
可选
🟠400请求有误
🟠401没有权限
🔴500服务器错误
🔴500服务器错误
修改于 2024-11-22 03:29:06