medusa-store/docs/api/admin/paths/payment-collections_{id}.yaml

delete:
  operationId: DeletePaymentCollectionsPaymentCollection
  summary: Delete a Payment Collection
  description: Deletes a Payment Collection
  x-authenticated: true
  parameters:
    - in: path
      name: id
      required: true
      description: The ID of the Payment Collection to delete.
      schema:
        type: string
  x-codeSamples:
    - lang: JavaScript
      label: JS Client
      source:
        $ref: ../code_samples/JavaScript/payment-collections_{id}/deleteundefined
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/payment-collections_{id}/deleteundefined
  security:
    - api_token: []
    - cookie_auth: []
  tags:
    - PaymentCollection
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            type: object
            properties:
              id:
                type: string
                description: The ID of the deleted Payment Collection.
              object:
                type: string
                description: The type of the object that was deleted.
                format: payment_collection
              deleted:
                type: boolean
                description: Whether or not the Payment Collection was deleted.
                default: true
    '400':
      $ref: ../components/responses/400_error.yaml
    '401':
      $ref: ../components/responses/unauthorized.yaml
get:
  operationId: GetPaymentCollectionsPaymentCollection
  summary: Retrieve an PaymentCollection
  description: Retrieves a PaymentCollection.
  x-authenticated: true
  parameters:
    - in: path
      name: id
      required: true
      description: The ID of the PaymentCollection.
      schema:
        type: string
    - in: query
      name: expand
      description: Comma separated list of relations to include in the results.
      schema:
        type: string
    - in: query
      name: fields
      description: Comma separated list of fields to include in the results.
      schema:
        type: string
  x-codeSamples:
    - lang: JavaScript
      label: JS Client
      source:
        $ref: ../code_samples/JavaScript/payment-collections_{id}/getundefined
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/payment-collections_{id}/getundefined
  security:
    - api_token: []
    - cookie_auth: []
  tags:
    - PaymentCollection
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            type: object
            properties:
              payment_collection:
                $ref: ../components/schemas/payment_collection.yaml
    '400':
      $ref: ../components/responses/400_error.yaml
    '401':
      $ref: ../components/responses/unauthorized.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
post:
  operationId: PostPaymentCollectionsPaymentCollection
  summary: Updates a PaymentCollection
  description: Updates a PaymentCollection.
  x-authenticated: true
  parameters:
    - in: path
      name: id
      required: true
      description: The ID of the PaymentCollection.
      schema:
        type: string
  requestBody:
    content:
      application/json:
        schema:
          type: object
          properties:
            description:
              description: >-
                An optional description to create or update the payment
                collection.
              type: string
            metadata:
              description: >-
                An optional set of key-value pairs to hold additional
                information.
              type: object
  x-codeSamples:
    - lang: JavaScript
      label: JS Client
      source:
        $ref: ../code_samples/JavaScript/payment-collections_{id}/postundefined
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/payment-collections_{id}/postundefined
  security:
    - api_token: []
    - cookie_auth: []
  tags:
    - PaymentCollection
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            type: object
            properties:
              payment_collection:
                $ref: ../components/schemas/payment_collection.yaml
    '400':
      $ref: ../components/responses/400_error.yaml
    '401':
      $ref: ../components/responses/unauthorized.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