Files
medusa-store/docs-util/oas-output/operations/admin/get_admin_fulfillment-providers.ts
github-actions[bot] bfda7a626d chore(docs): Generated OAS (#7189)
This PR holds all generated OAS for the upcoming release.

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2024-05-01 10:07:31 +00:00

57 lines
1.5 KiB
TypeScript

/**
* @oas [get] /admin/fulfillment-providers
* operationId: GetFulfillmentProviders
* summary: List Fulfillment Providers
* description: Retrieve a list of fulfillment providers. The fulfillment providers
* can be filtered by fields such as `id`. The fulfillment providers can also be
* sorted or paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - fields
* properties:
* fields:
* type: string
* title: fields
* description: The fulfillment provider's fields.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/fulfillment-providers' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "fields": "{value}"
* }'
* tags:
* - Fulfillment Providers
* responses:
* "200":
* description: OK
* "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"
*
*/