Files
medusa-store/docs/api/store/paths/gift-cards_{code}.yaml
2022-09-05 10:23:46 +03:00

42 lines
1.1 KiB
YAML

get:
operationId: GetGiftCardsCode
summary: Retrieve Gift Card by Code
description: Retrieves a Gift Card by its associated unqiue code.
parameters:
- in: path
name: code
required: true
description: The unique Gift Card code.
schema:
type: string
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/gift-cards_{code}/getundefined
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/gift-cards_{code}/getundefined
tags:
- Gift Card
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
gift_card:
$ref: ../components/schemas/gift_card.yaml
'400':
$ref: ../components/responses/400_error.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml