get: operationId: GetOrdersOrder summary: Get an Order description: Retrieves an Order x-authenticated: true parameters: - in: path name: id required: true description: The ID of the Order. schema: type: string x-codeSamples: - lang: JavaScript label: JS Client source: $ref: ../code_samples/JavaScript/orders_{id}/getundefined - lang: Shell label: cURL source: $ref: ../code_samples/Shell/orders_{id}/getundefined security: - api_token: [] - cookie_auth: [] tags: - Order responses: '200': description: OK content: application/json: schema: properties: order: $ref: ../components/schemas/order.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: PostOrdersOrder summary: Update an Order description: Updates and order x-authenticated: true parameters: - in: path name: id required: true description: The ID of the Order. schema: type: string requestBody: content: application/json: schema: properties: email: description: the email for the order type: string billing_address: description: Billing address anyOf: - $ref: ../components/schemas/address.yaml shipping_address: description: Shipping address anyOf: - $ref: ../components/schemas/address.yaml items: description: The Line Items for the order type: array items: $ref: ../components/schemas/line_item.yaml region: description: ID of the region where the order belongs type: string discounts: description: Discounts applied to the order type: array items: $ref: ../components/schemas/discount.yaml customer_id: description: ID of the customer type: string payment_method: description: payment method chosen for the order type: object properties: provider_id: type: string description: ID of the payment provider data: description: Data relevant for the given payment method type: object shipping_method: description: The Shipping Method used for shipping the order. type: object properties: provider_id: type: string description: The ID of the shipping provider. profile_id: type: string description: The ID of the shipping profile. price: type: integer description: The price of the shipping. data: type: object description: Data relevant to the specific shipping method. items: type: array items: $ref: ../components/schemas/line_item.yaml description: Items to ship no_notification: description: >- A flag to indicate if no notifications should be emitted related to the updated order. type: boolean x-codeSamples: - lang: JavaScript label: JS Client source: $ref: ../code_samples/JavaScript/orders_{id}/postundefined - lang: Shell label: cURL source: $ref: ../code_samples/Shell/orders_{id}/postundefined security: - api_token: [] - cookie_auth: [] tags: - Order responses: '200': description: OK content: application/json: schema: properties: order: $ref: ../components/schemas/order.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