129 lines
3.8 KiB
TypeScript
129 lines
3.8 KiB
TypeScript
/**
|
|
* @oas [post] /admin/regions
|
|
* operationId: PostRegions
|
|
* summary: Create Region
|
|
* description: Create a region.
|
|
* x-authenticated: true
|
|
* parameters:
|
|
* - name: expand
|
|
* in: query
|
|
* description: Comma-separated relations that should be expanded in the returned data.
|
|
* required: false
|
|
* schema:
|
|
* type: string
|
|
* title: expand
|
|
* description: Comma-separated relations that should be expanded in the returned data.
|
|
* - name: fields
|
|
* in: query
|
|
* description: Comma-separated fields that should be included in the returned data.
|
|
* required: false
|
|
* schema:
|
|
* type: string
|
|
* title: fields
|
|
* description: Comma-separated fields that should be included in the returned data.
|
|
* - name: offset
|
|
* in: query
|
|
* description: The number of items to skip when retrieving a list.
|
|
* required: false
|
|
* schema:
|
|
* type: number
|
|
* title: offset
|
|
* description: The number of items to skip when retrieving a list.
|
|
* - name: limit
|
|
* in: query
|
|
* description: Limit the number of items returned in the list.
|
|
* required: false
|
|
* schema:
|
|
* type: number
|
|
* title: limit
|
|
* description: Limit the number of items returned in the list.
|
|
* - name: order
|
|
* in: query
|
|
* description: Field to sort items in the list by.
|
|
* required: false
|
|
* schema:
|
|
* type: string
|
|
* title: order
|
|
* description: Field to sort items in the list by.
|
|
* security:
|
|
* - api_token: []
|
|
* - cookie_auth: []
|
|
* - jwt_token: []
|
|
* requestBody:
|
|
* content:
|
|
* application/json:
|
|
* schema:
|
|
* $ref: "#/components/schemas/CreateRegion"
|
|
* x-codeSamples:
|
|
* - lang: Shell
|
|
* label: cURL
|
|
* source: |-
|
|
* curl -X POST '{backend_url}/admin/regions' \
|
|
* -H 'x-medusa-access-token: {api_token}' \
|
|
* -H 'Content-Type: application/json' \
|
|
* --data-raw '{
|
|
* "name": "Giovanna",
|
|
* "currency_code": "{value}"
|
|
* }'
|
|
* tags:
|
|
* - Regions
|
|
* responses:
|
|
* "400":
|
|
* $ref: "#/components/responses/400_error"
|
|
* "401":
|
|
* $ref: "#/components/responses/unauthorized"
|
|
* "404":
|
|
* $ref: "#/components/responses/not_found_error"
|
|
* "409":
|
|
* $ref: "#/components/responses/invalid_state_error"
|
|
* "422":
|
|
* $ref: "#/components/responses/invalid_request_error"
|
|
* "500":
|
|
* $ref: "#/components/responses/500_error"
|
|
* requestBody:
|
|
* content:
|
|
* application/json:
|
|
* schema:
|
|
* type: object
|
|
* required:
|
|
* - name
|
|
* - currency_code
|
|
* - countries
|
|
* - automatic_taxes
|
|
* - payment_providers
|
|
* - metadata
|
|
* properties:
|
|
* name:
|
|
* type: string
|
|
* title: name
|
|
* description: The region's name.
|
|
* currency_code:
|
|
* type: string
|
|
* title: currency_code
|
|
* description: The region's currency code.
|
|
* countries:
|
|
* type: array
|
|
* description: The region's countries.
|
|
* items:
|
|
* type: string
|
|
* title: countries
|
|
* description: The country's countries.
|
|
* automatic_taxes:
|
|
* type: boolean
|
|
* title: automatic_taxes
|
|
* description: The region's automatic taxes.
|
|
* payment_providers:
|
|
* type: array
|
|
* description: The region's payment providers.
|
|
* items:
|
|
* type: string
|
|
* title: payment_providers
|
|
* description: The payment provider's payment providers.
|
|
* metadata:
|
|
* type: object
|
|
* description: The region's metadata.
|
|
* properties: {}
|
|
*
|
|
*/
|
|
|