Files
medusa-store/www/apps/docs/content/references/js-client/modules/internal-7.md
github-actions[bot] daea35fe73 chore(docs): Generated JS Client Reference (#5334)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2023-10-10 17:47:07 +00:00

1.7 KiB

displayed_sidebar
displayed_sidebar
jsClientSidebar

Module: internal

Classes

Type Aliases

AdminCustomersListRes

Ƭ AdminCustomersListRes: PaginatedResponse & { customers: Customer[] }

Schema

AdminCustomersListRes type: object required:

  • customers
  • count
  • offset
  • limit properties: customers: type: array description: "An array of customer details." items: $ref: "#/components/schemas/Customer" count: type: integer description: The total number of items available offset: type: integer description: The number of customers skipped when retrieving the customers. limit: type: integer description: The number of items per page

Defined in

packages/medusa/dist/api/routes/admin/customers/index.d.ts:47


AdminCustomersRes

Ƭ AdminCustomersRes: Object

Schema

AdminCustomersRes type: object x-expanded-relations: field: customer relations: - orders - shipping_addresses required:

  • customer properties: customer: description: "Customer details." $ref: "#/components/schemas/Customer"

Type declaration

Name Type
customer Customer

Defined in

packages/medusa/dist/api/routes/admin/customers/index.d.ts:20