post: operationId: PostDraftOrders summary: Create a Draft Order description: Creates a Draft Order x-authenticated: true requestBody: content: application/json: schema: $ref: ../components/schemas/AdminPostDraftOrdersReq.yaml x-codeSamples: - lang: JavaScript label: JS Client source: $ref: ../code_samples/JavaScript/draft-orders/postundefined - lang: Shell label: cURL source: $ref: ../code_samples/Shell/draft-orders/postundefined security: - api_token: [] - cookie_auth: [] tags: - Draft Order responses: '200': description: OK content: application/json: schema: type: object properties: draft_order: $ref: ../components/schemas/DraftOrder.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 get: operationId: GetDraftOrders summary: List Draft Orders description: Retrieves an list of Draft Orders x-authenticated: true parameters: - in: query name: offset description: The number of items to skip before the results. schema: type: number default: '0' - in: query name: limit description: Limit the number of items returned. schema: type: number default: '50' - in: query name: q description: >- a search term to search emails in carts associated with draft orders and display IDs of draft orders schema: type: string x-codeSamples: - lang: JavaScript label: JS Client source: $ref: ../code_samples/JavaScript/draft-orders/getundefined - lang: Shell label: cURL source: $ref: ../code_samples/Shell/draft-orders/getundefined security: - api_token: [] - cookie_auth: [] tags: - Draft Order responses: '200': description: OK content: application/json: schema: type: object properties: draft_orders: type: array items: $ref: ../components/schemas/DraftOrder.yaml count: type: integer description: The total number of items available offset: type: integer description: The number of items skipped before these items limit: type: integer description: The number of items per page '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