openapi: 3.0.0 info: title: Event-Stream Webhooks version: v0 servers: - url: https://example.com/newstore_api/v0 security: - ApiKeyAuth: [] paths: /event: post: responses: '200': description: > The event publishing request from NewStore was successfully accepted by your system. **Important:** If you respond with anything other than a 200 response code, the whole event stream is interrupted and NewStore will keep sending you the last event you didn't acknowledge with a 200 response code. When you reach the retry limit, no events are sent. '400': description: > The event publishing request from NewStore cannot be processed because of an error on the client side. The NewStore platform is not retrying and stopping the integration. **Important:** When you respond with this error code, the whole event stream is interrupted. No new events are sent. To restart the event stream, use the [start method](/newstore-cloud/event_stream/stream_webhook_sink_api.html#operation/startIntegration). '403': description: > The event publishing request from NewStore cannot be processed because the authorization token is not accepted by the client side. The NewStore platform is not retrying and stopping the integration. **Important:** When you respond with this error code, the whole event stream is interrupted. No new events are sent. To restart the event stream, use the [start method](/newstore-cloud/event_stream/stream_webhook_sink_api.html#operation/startIntegration). '429': description: > The event publishing request from NewStore failed because too many requests were sent to your system. The NewStore platform is throttling the requests and retrying the operation according to parameters defined during integration. **Important:** When you respond with this error code, the whole event stream is interrupted and NewStore will keep sending the last event you didn't acknowledge with a 200 response code. When you reach the retry limit, no events are sent. '500': description: > The event publishing request from NewStore cannot be processed because of an internal error on the external system's side. NewStore throttles the requests and retries the operation according to parameters defined during integration. **Important:** When you respond with this error code, the whole event stream is interrupted and NewStore will keep sending the last event you didn't acknowledge with a 200 response code. When you reach the retry limit, no events are sent. description: > Incoming call from NewStore that contains an event. The event is described in the request. **Managing duplicate events:** You can receive data from Newstore via Event stream webhooks, as Newstore supports emitting data at least once to your integration point. However, Event stream webhooks sometimes deliver events more than once. To protect your integration point from duplicate events, we advise you to make your event processing [idempotent](https://en.wikipedia.org/wiki/Idempotence). You can detect duplicate events by comparing your event's idempotency key with the idempotency keys of previous events. For each event, you will see an idempotency key in your webhook description. For more information, see [Stripe's blog](https://stripe.com/en-de/blog/idempotency) on idempotency or the NewStore [guide](/developers/guides/eventstream#managing-duplicate-events). > **_NOTE:_** Currently the idempotency key is only unique *per event*. Add the event name to the idempotency key to get a unique key across all events. **Order of events:** You will not receive events in a specific order. You may receive an `order.cancelled` event before the corresponding `order.created` event. **Event delivery:** We take at most 15 minutes to send an event to your integration endpoint according to the service-level agreement (SLA) between a retailer and NewStore. However, usually, it takes seconds to complete this operation. **Response code:** The response code you send back decides whether the whole stream should be interrupted or maintained. See the **Responses** section below for more information. **Deprecation note:** The `order.shipped` event has been deprecated. Use the `order.completed` event for data related to orders that are closed in the NewStore platform. operationId: publishEvent summary: Sends Newstore events to subscribed webhooks or S3 buckets requestBody: content: application/json: examples: order.created: description: > The order has been successfully created in the NewStore Omnichannel Cloud. If the payment authorization fails, this event is not emitted but you might be able to see this order in NewStore Omnichannel Manager, depending on your configuration. This event is sent at the beginning of the grace period. See the [order lifecycle](https://docs.newstore.com/docs/order-lifecycle-bpm) for more information about the possible next events to expect. **Idempotency key:** `id` value: tenant: businessname name: order.created published_at: '2010-01-01T12:00:00.000Z' payload: id: 04d02325-f4ea-4a7b-bfeb-2ff74a0e1a0d external_id: NSD000000001 created_at: '2018-07-06T11:56:34.712Z' placed_at: '2018-07-06T12:06:25.989Z' associate_id: fe203100e1e2416ba6932d1561ccc380 associate_email: some@qa2.com channel_type: web channel: webshop-123 is_exchange: false customer_email: johndoe@example.com customer_id: 3dd42342-0937-4c12-b393-d2c849a590d5 external_customer_id: CUST123423 is_historical: false discounts: - trigger: coupon discount_id: xxyz1b25-0937-4c12-b393-d2c849a590d5 coupon_code: COUPON10E billing_address: first_name: John last_name: Doe address_line_1: 800 California St address_line_2: '' address_line1: 800 California St address_line2: '' zip_code: '94108' city: San Francisco state: CA country: US phone: '' shipping_address: first_name: John last_name: Doe address_line_1: 800 California St address_line_2: '' address_line1: 800 California St address_line2: '' zip_code: '94108' city: San Francisco state: CA country: US phone: '07534706323' price_method: tax_excluded subtotal: 295 discount_total: 0 shipping_total: 42 shipping_tax: 0 tax_total: 25.08 grand_total: 320.08 currency: USD tax_strategy: fixedrate tax_exempt: false extended_attributes: - name: Order level attribute one value: some value - name: Order level attribute two value: 'true' items: - id: c1348089-1889-4cb8-8846-ad054d066fbf item_type: product product_id: '1005404' pricebook_id: default pricebook_price: 295 list_price: 295 item_discounts: 0 order_discounts: 0 tax: 25.08 tax_provider_details: - name: Custom Tax amount: 25.08 rate: 0.2 tax_class: PC040100 quantity: 1 status: created shipping_service_level: STANDARD_OVERNIGHT is_preorder: false future_fulfillment_location_id: 874e9179-b87f-40f0-a07e-3e6d28ef8fd9 shipping_method: traditional_carrier extended_attributes: - name: Item level attribute one value: '123.45' - name: Item level attribute two value: 'false' discounts: - id: ac568994-28ce-420a-b053-c0010e315920 price_adjustment: 44 reason: Coupon EMPLOYEE action: percentage value: 50 level: order coupon_code: CODE123 externalRef: 914e9179-b87f-40f0-a07e-3e6d287f8fd8 order.opened: description: > The grace period is over and NewStore Omnichannel Cloud starts the fulfillment process. This event is also sent when an order has been imported (historical order). See the [order lifecycle](https://docs.newstore.com/docs/order-lifecycle-bpm) for more information about the possible next events to expect. **Idempotency key:** `id` value: tenant: businessname name: order.opened published_at: '2018-07-27T13:39:42.470Z' payload: id: acda1b25-0937-4c12-b393-d2c849a590d5 external_id: NSD000000003 created_at: '2018-07-27T13:38:52.440Z' placed_at: '2018-07-27T13:38:32.424Z' channel_type: store channel: store-1234 demand_location_id: store-1234 is_exchange: false customer_email: johndoe@example.com customer_id: 3dd42342-0937-4c12-b393-d2c849a590d5 external_customer_id: CUST123423 is_historical: false discounts: - trigger: coupon discount_id: xxyz1b25-0937-4c12-b393-d2c849a590d5 coupon_code: COUPON10E billing_address: first_name: john last_name: doe address_line_1: 745 Atlantic Ave address_line_2: '' address_line1: 745 Atlantic Ave address_line2: '' zip_code: '02111' city: Boston state: MA country: US phone: '' shipping_address: first_name: john last_name: doe address_line_1: 745 Atlantic Ave address_line_2: '' address_line1: 745 Atlantic Ave address_line2: '' zip_code: '02111' city: Boston state: MA country: US phone: '07534706323' price_method: tax_excluded subtotal: 39.47 discount_total: 0 shipping_total: 15 shipping_tax: 0 tax_total: 2.47 grand_total: 41.94 currency: USD tax_strategy: fixedrate tax_exempt: false extended_attributes: - name: Order level attribute one value: 'true' items: - id: c0246781-ef26-496d-90da-388fc0995fbb item_type: product product_id: product1-KTTJmD_rRFDmS pricebook_id: default pricebook_price: 39.47 list_price: 39.47 item_discounts: 0 order_discounts: 0 tax: 2.47 tax_class: PC040100 quantity: 1 status: opened shipping_service_level: DELIV is_preorder: false future_fulfillment_location_id: 874e9179-b87f-40f0-a07e-3e6d28ef8fd9 shipping_method: traditional_carrier extended_attributes: - name: Item level attribute one value: '123.45' - name: Item level attribute two value: 'false' discounts: - id: ac568994-28ce-420a-b053-c0010e315920 price_adjustment: 44 reason: Coupon EMPLOYEE action: percentage value: 50 level: order coupon_code: CODE123 externalRef: 914e9179-b87f-40f0-a07e-3e6d287f8fd8 order.shipped: description: | **DEPRECATED.** Use the `Order completed` event instead. value: tenant: businessname name: order.shipped published_at: '2010-01-01T12:00:00.000Z' payload: id: 4e734ed0-6698-4756-9c68-4efdde0a6681 capture_type: pos items: - id: 2912bc21-9ad0-4efa-b4b6-aec4384901dc product_id: ASDF1000 quantity: 1 status: shipped fulfillment_location_id: US01 shipping_service_level: DELIV shipping_method: traditional_carrier order.completed: description: > All the items of the order have been shipped or swapped (except for cancelled items). **Note about swapped items:** The `status` property is set to `swapped` when the item has been swapped. To collect information about which item replaced the item marked as swapped, use the `Order item swapped` event. See the [order lifecycle](https://docs.newstore.com/docs/order-lifecycle-bpm) for more information about the possible next events to expect. **Idempotency key:** `id` value: tenant: businessname name: order.completed published_at: '2010-01-01T12:00:00.000Z' payload: id: 4e734ed0-6698-4756-9c68-4efdde0a6681 capture_type: pos items: - id: 2912bc21-9ad0-4efa-b4b6-aec4384901dc product_id: ASDF1000 quantity: 1 status: shipped fulfillment_location_id: US01 shipping_service_level: DELIV shipping_method: traditional_carrier order.cancelled: description: > The order has been cancelled, or all of its items have been cancelled. See the [order lifecycle](https://docs.newstore.com/docs/order-lifecycle-bpm) for more information about the possible next events to expect. **Idempotency key:** `id` value: tenant: businessname name: order.cancelled published_at: '2010-01-01T12:00:00.000Z' payload: id: 1431b891-c056-4f80-9d34-06479b383417 cancellation_reason: insufficient_stock capture_type: pos items: - id: 8c2a657e-e8c7-4f1b-b6d5-ab27d2ec87a1 product_id: ASDF1000 quantity: 1 status: cancelled fulfillment_location_id: US01 shipping_service_level: DELIV shipping_method: traditional_carrier - id: 9c027c6f-2918-457e-9051-0c6a349701df product_id: ASDF1000 quantity: 1 status: cancelled fulfillment_location_id: US01 shipping_service_level: DELIV shipping_method: traditional_carrier order.items_cancelled: description: > One or more items of the order were cancelled. This event can happen when: - the fulfillment location cannot fulfill the item. For example, the item is lost or damaged. - the order was modified during grace period. For example, the customer called the customer care center. See the [order lifecycle](https://docs.newstore.com/docs/order-lifecycle-bpm) for more information about the possible next events to expect. **Idempotency key:** Concatenate `id` and all item `id` attributes. value: tenant: businessname name: order.items_cancelled published_at: '2010-01-01T12:00:00.000Z' payload: id: 1431b891-c056-4f80-9d34-06479b383417 items: - id: 8c2a657e-e8c7-4f1b-b6d5-ab27d2ec87a1 product_id: ASDF1000 fulfillment_location_id: US01 cancellation_reason: insufficient_stock - id: 9c027c6f-2918-457e-9051-0c6a349701df product_id: ASDF1001 fulfillment_location_id: US01 cancellation_reason: cancellation_request order.items_on_hold: description: > One or more items of the order could not be fulfilled from a fulfillment location. Manual intervention is required to unblock the order. This event can for example happen when a fulfillment location cannot fulfill the item due to insufficient inventory. **Important**: This event will not be emitted if the order goes to on-hold due to exceptions when requesting the shipping label during the fulfillment process. See the [order lifecycle](https://docs.newstore.com/docs/order-lifecycle-bpm) for more information about the possible next events to expect. **Idempotency key:** Concatenate `id` and `revision`. value: tenant: businessname name: order.items_on_hold published_at: '2010-01-01T12:00:00.000Z' payload: id: 1431b891-c056-4f80-9d34-06479b383417 external_id: NWST00000000123 revision: 12 items: - id: 8c2a657e-e8c7-4f1b-b6d5-ab27d2ec87a1 product_id: ASDF1000 fulfillment_location_id: US01 reason: insufficient_stock - id: 9c027c6f-2918-457e-9051-0c6a349701df product_id: ASDF1001 fulfillment_location_id: US01 reason: insufficient_stock order.items_swapped: description: > An item of the order is swapped with another product. The item that was swapped will have its status set to `swapped` in the `order.completed` event. See the [order lifecycle](https://docs.newstore.com/docs/order-lifecycle-bpm) for more information about the possible next events to expect. **Idempotency key:** Concatenate `id` and all item `replacement_item_id` attributes. value: tenant: businessname name: order.items_swapped published_at: '2010-01-01T12:00:00.000Z' payload: id: d25f6606-5f2c-4cf9-acd9-e23dcbd97685 associate_id: RbARlfBJbADNiq6PPPwf replaced_at: '2018-07-06T12:31:19.437Z' replaced_product_id: '1000041' replacement_product_id: '1000761' replaced_item_id: b0c4307d-d50a-493f-bf99-3b6f9351489a replacement_item_id: 265b39ef-e6b3-413c-9b86-46348de0afa9 reason: (Customer) Wrong size ordered reason_notes: customer asked to swap order.serial_numbers_added: description: > One or more items of the order were assigned a serial number. See the [order information retrievel API](/newstore-cloud/order_management/sales_order.html#operation/put-serial-numbers-for-items) for more information on how a serial number may be assigned to an item. **Idempotency key:** Concatenate `id` and the `revision` attribute. value: tenant: businessname name: order.serial_numbers_added published_at: '2010-01-01T12:00:00.000Z' payload: id: 1431b891-c056-4f80-9d34-06479b383417 items: - id: 8c2a657e-e8c7-4f1b-b6d5-ab27d2ec87a1 serial_number: serial-number-1234 - id: 9c027c6f-2918-457e-9051-0c6a349701df serial_number: serial-number-5678 epc: some-epc-code revision: 2 order.customer_profile_amended: description: > A customer profile has been amended to an order in the NewStore Omnichannel Cloud **Idempotency key:** Hashed key based on the amendment request parameters. value: tenant: businessname name: order.customer_profile_amended published_at: '2010-01-01T12:00:00.000Z' payload: order_id: 1431b891-c056-4f80-9d34-06479b383417 customer_id: 3dd42342-0937-4c12-b393-d2c849a590d5 customer_email: johndoe@example.com invoice.created: description: > A new invoice has been created in the NewStore Omnichannel Cloud. **Idempotency key:** `id` value: tenant: businessname name: invoice.created published_at: '2010-01-01T12:00:00.000Z' payload: id: 04d02325-f4ea-4a7b-bfeb-2ff74a0e1a0d external_id: INV000000001 order_id: f00957da-e175-40e0-b8bf-ef47623a8518 created_at: '2018-07-06T11:56:34.712Z' discount_total: 0 shipping_total: 42 tax_total: 25.08 grand_total: 362.08 currency: USD invoice_url: >- https://example.com/documents/b026e3c7-0379-499f-a3d4-dd097faf6687 tax_provider_details: - name: Custom Tax amount: 25.08 rate: 0.2 items: - id: c1348089-1889-4cb8-8846-ad054d066fbf product_id: '1005404' product_name: Stella Dress amount: 295 tax: 25.08 item_discounts: 0 order_discounts: 0 fulfillment_request.assigned: description: > The [fulfillment request](https://docs.newstore.com/docs/glossary#fulfillment-request) has been assigned to a fulfillment location. This includes the successful allocation of the items which are part of the fulfillment request. See the [Fulfillment requests](/newstore-cloud/newstore.html#fulfillment-requests) resource to manage fulfillment requests and the [order lifecycle](https://docs.newstore.com/docs/order-lifecycle-bpm) for more information about the possible next events to expect. **Idempotency key:** `id` value: tenant: businessname name: fulfillment_request.assigned published_at: '2010-01-01T12:00:00.000Z' payload: id: 8d249e38-d9b5-40ce-bdb7-c2767ba35bca order_id: fc17d99d-f83f-43be-a3f0-b4020651df63 logical_timestamp: 3047 created_at: '2000-01-01T12:34:56.789Z' fulfillment_location_id: US03 service_level: 2_DAY associate_id: ba089300ecb04916b9b41bd7eab2a537 items: - id: 66c31ec8-de38-4190-a772-7b092006d58d product_id: '841725142312' carrier_service: FEDEX_2_DAY fulfillment_request.items_completed: description: > Some items in the [fulfillment request](https://docs.newstore.com/docs/glossary#fulfillment-request) have either been shipped or handed over to the customer. **Important** Every time this event is emitted, it includes **all** items from this fulfillment request that were shipped by now. See the [Fulfillment requests](/newstore-cloud/newstore.html#fulfillment-requests) resource to manage fulfillment requests and the [order lifecycle](https://docs.newstore.com/docs/order-lifecycle-bpm) for more information about the possible next events to expect. **Idempotency key:** Concatenate `id` and all item `id` attributes. value: tenant: businessname name: fulfillment_request.items_completed published_at: '2010-01-01T12:00:00.000Z' payload: id: 1fa2c648-f954-4775-a5fc-91f4a07902a6 order_id: 3f2e71b6-e700-4573-8545-c46b9e0961a0 logical_timestamp: 3814 fulfillment_location_id: US01 service_level: 2_DAY associate_id: xa089300ecb04916b9b41bd7eab2a587 items: - id: 8c2a657e-e8c7-4f1b-b6d5-ab27d2ec87a1 product_id: '10000233' tracking_code: '1029291' carrier: DHL shipped_at: '2010-01-01T11:00:00.000Z' carrier_service: DHL_EXPRESS - id: 9c027c6f-2918-457e-9051-0c6a349701df product_id: '10000234' tracking_code: '1029291' carrier: DHL shipped_at: '2010-01-01T11:00:00.000Z' carrier_service: DHL_EXPRESS fulfillment_request.items_failed: description: > Some items in the [fulfillment request](https://docs.newstore.com/docs/glossary#fulfillment-request) could not be fulfilled (mispick or mispack occurred). Re-routing is required. See the [Fulfillment requests](/newstore-cloud/newstore.html#fulfillment-requests) resource to manage fulfillment requests and the [order lifecycle](https://docs.newstore.com/docs/order-lifecycle-bpm) for more information about the possible next events to expect. **Idempotency key:** Concatenate `id` and all item `id` attributes. value: tenant: businessname name: fulfillment_request.items_failed published_at: '2010-01-01T12:00:00.000Z' payload: id: f49bf6d2-bfb8-43b3-bb40-165430f02d45 order_id: 0325d0a3-bf9c-451b-8a48-eb07490b972d logical_timestamp: 3633 fulfillment_location_id: US03 service_level: SAME_DAY_DELIVERY associate_id: xa089300ecb04916b9b41bd7eab2a587 items: - id: 66c31ec8-de38-4190-a772-7b092006d58d product_id: '841725142312' rejection_reason: no_inventory fulfillment_rejection_reason: Damaged fulfillment_request.items_ready_for_handover: description: > Some items in the [fulfillment request](https://docs.newstore.com/docs/glossary#fulfillment-request) are ready to be handed over to the customer or to shipping carrier. See the [order lifecycle](https://docs.newstore.com/docs/order-lifecycle-bpm) for more information about the possible next events to expect. **Idempotency key**: Concatenate id and all item id attributes. value: tenant: businessname name: fulfillment_request.items_ready_for_handover published_at: '2010-01-01T12:00:00.000Z' payload: id: 8d249e38-d9b5-40ce-bdb7-c2767ba35bca order_id: fc17d99d-f83f-43be-a3f0-b4020651df63 logical_timestamp: 3047 fulfillment_location_id: US03 service_level: IN_STORE_PICKUP associate_id: fe203100e1e2416ba6932d1561ccc380 items: - id: 66c31ec8-de38-4190-a772-7b092006d58d product_id: '841725142312' return.processed: description: > A return was successfully processed. All returned items have been processed by the store/warehouse employees. **Idempotency key:** `id` value: tenant: businessname name: return.processed published_at: '2010-01-01T12:00:00.000Z' payload: id: bfc4ee76-ac31-4a2e-870d-40c103c08bec order_id: fb398ea3-59db-4b2b-9445-522c05a237c1 external_order_id: NSD000000001 returned_at: '2017-10-30T12:17:43.640Z' total_refund_amount: 99.95 total_refund_amount_adjusted: 99.95 total_refund_excl_tax: 83.29 total_refund_tax: 16.66 refunded_amount: 99.95 return_fee: 0 currency: GBP return_location_id: US01 customer_id: cb398ea3-59db-4b2b-9445-522c05a237c1 customer_email: john.doe@example.com associate_id: xb398ea3-59db-4b2b-9445-522c05a2377 associate_email: some@example.com items: - id: 75af87aa-2b6c-474d-9a68-719a34e557e1 product_id: CM8246-600 item_type: product item_condition: Sellable condition_code: 1 return_reason: Other return_code: 1 refund_excl_tax: 83.29 refund_tax: 16.66 refund_amount: 99.95 refund_amount_adjusted: 99.95 quantity: 1 external_identifiers: serial_number: '1234567890' external_item_id: ABCDEF123456 - id: 85af87aa-2b6c-474d-9a68-719a34e557e1 product_id: shipping item_type: shipping condition_code: 1 return_code: 1 refund_excl_tax: 5.01 refund_tax: 0.89 refund_amount: 5.9 refund_amount_adjusted: 5.9 quantity: 1 - id: a4f65e06-017d-455b-8d75-e63a3998220b product_id: ABCD12-655 item_type: product item_condition: Sellable condition_code: 1 return_reason: Other return_code: 1 refund_excl_tax: 56.77 refund_tax: 11.67 refund_amount: 103.65 refund_amount_adjusted: 103.65 quantity: 1 external_identifiers: external_item_id: XZY5689asd42 refund_request.issued: description: > A store employee initiated a compensation procedure (total or partial refund) to appease an unsatisfied customer. **Note:** This event is not about financial refund transactions. A refund request triggers one or more refund transactions, but does not represent them. Financial refund transactions are represented by Payment account amount refunded. **Idempotency key:** `id` value: tenant: businessname name: refund_request.issued published_at: '2010-01-01T12:00:00.000Z' payload: id: f307dfac-1b91-416e-8f90-3e04119482c7 order_id: 78fcee43-ce54-4d90-8e59-a8312db705e8 payment_account_id: 78fcee43-ce54-4d90-8e59-a8312db705e8 note: The white shirt has yellow stains on it amount: 1.42 return_reason: Products damaged or dirty currency: USD reason_code: 2 requested_at: '2010-01-01T11:00:00.000Z' associate_id: x307dfac-1b91-416e-8f90-3e04119482c9 associate_email: some@test.com items: - id: 006c497d-8f50-4104-a204-b73d0a937486 type: product amount: 59.95 - id: 007c497d-8f50-4104-a204-b73d0a937487 type: product amount: 19.99 - id: 123c497d-8f50-4104-a204-b73d0a937488 type: shipping amount: 5.95 payment_account.amount_authorized: description: > A payment has been successfully authorized. **Idempotency key:** concatenate `id` and all transaction `id` attributes. value: tenant: businessname name: payment_account.amount_authorized published_at: '2010-01-01T12:00:00.000Z' payload: id: c7bb2b86-c7c3-4f73-a33f-5cbc230a71d4 order_id: c7bb2b86-c7c3-4f73-a33f-5cbc230a71d4 external_order_id: NSD000000003 transactions: - id: 27da6ba8-71d9-456c-bb8a-1af0898819e7 instrument_id: 006c497d-8f50-4104-a204-b73d0a937486 amount: 300 currency: USD extended_attributes: some_string_attribute: '2345678' some_numeric_attribute: 17 some_bool_attribute: true some_date_attribute: '2022-01-26T06:55:44Z' some_object: some_key: some value some_sub_object: other_key_1: other value other_key_2: false instruments: - id: 006c497d-8f50-4104-a204-b73d0a937486 payment_method: credit_card payment_wallet: direct payment_provider: adyen payment_origin: newstore_checkout payment_account.amount_captured: description: > The authorized amount was successfully transferred from the customer to the tenant. This event happens when an item is shipped. **Idempotency key:** concatenate `id` and all transaction `id` attributes. value: tenant: businessname name: payment_account.amount_captured published_at: '2010-01-01T12:00:00.000Z' payload: id: c7bb2b86-c7c3-4f73-a33f-5cbc230a71d4 order_id: c7bb2b86-c7c3-4f73-a33f-5cbc230a71d4 external_order_id: NSD000000003 transactions: - id: 0af7277e-3adc-4385-bc40-686b345d1902 instrument_id: 99a0d18e-8f89-435a-896b-75c3ff30e369 amount: 300 currency: USD extended_attributes: some_string_attribute: '2345678' some_numeric_attribute: 17 some_bool_attribute: true some_date_attribute: '2022-01-26T06:55:44Z' some_object: some_key: some value some_sub_object: other_key_1: other value other_key_2: false - id: 27da6ba8-71d9-456c-bb8a-1af0898819e7 instrument_id: 006c497d-8f50-4104-a204-b73d0a937486 amount: 300 currency: USD instruments: - id: 99a0d18e-8f89-435a-896b-75c3ff30e369 payment_method: cash payment_wallet: direct payment_provider: cash - id: 006c497d-8f50-4104-a204-b73d0a937486 payment_method: credit_card payment_wallet: direct payment_provider: adyen payment_account.amount_refunded: description: > The previously captured amount was successfully transferred from the tenant to the customer. This event happens when an item is returned by the customer, or when an associate triggers an [appeasement](https://docs.newstore.com/docs/glossary#fulfillment-request). See the [order lifecycle](https://docs.newstore.com/docs/order-lifecycle-bpm) for more information about the possible next events to expect. **Idempotency key:** concatenate `id` and all transaction `id` attributes. value: tenant: businessname name: payment_account.amount_refunded published_at: '2010-01-01T12:00:00.000Z' payload: id: c7bb2b86-c7c3-4f73-a33f-5cbc230a71d4 order_id: c7bb2b86-c7c3-4f73-a33f-5cbc230a71d4 external_order_id: NSD000000003 transactions: - id: c7bb2b86-c7c3-4f73-a33f-5cbc230a71d4 instrument_id: 99a0d18e-8f89-435a-896b-75c3ff30e369 amount: 600 currency: USD correlation_id: bfc4ee76-ac31-4a2e-870d-40c103c08bec extended_attributes: some_string_attribute: '2345678' some_numeric_attribute: 17 some_bool_attribute: true some_date_attribute: '2022-01-26T06:55:44Z' some_object: some_key: some value some_sub_object: other_key_1: other value other_key_2: false - id: c55915af-840d-49af-bf8e-91bd7ef2aa79 instrument_id: 006c497d-8f50-4104-a204-b73d0a937486 amount: 300 currency: USD correlation_id: bfc4ee76-ac31-4a2e-870d-40c103c08bec extended_attributes: external_order_id: '2345678' shopify_order_id: '1234546501023' processed_at: '2022-01-26T06:55:44Z' transaction_id: '234234234' essential: external_order_id: '2345678' instruments: - id: 99a0d18e-8f89-435a-896b-75c3ff30e369 payment_method: cash payment_wallet: direct payment_provider: cash - id: 006c497d-8f50-4104-a204-b73d0a937486 payment_method: credit_card payment_wallet: direct payment_provider: adyen payment_account.amount_voided: description: | One or more authorized transactions have been voided. value: tenant: businessname name: payment_account.amount_voided published_at: '2010-01-01T12:00:00.000Z' payload: id: c7bb2b86-c7c3-4f73-a33f-5cbc230a71d4 order_id: e9f2c740-cd65-4a13-79ee-d463176e3d02 external_order_id: NSD000000003 transactions: - id: c55915af-840d-49af-bf8e-91bd7ef2aa79 instrument_id: 006c497d-8f50-4104-a204-b73d0a937486 amount: 300 currency: USD correlation_id: bfc4ee76-ac31-4a2e-870d-40c103c08bec extended_attributes: some_string_attribute: '2345678' some_numeric_attribute: 17 some_bool_attribute: true some_date_attribute: '2022-01-26T06:55:44Z' some_object: some_key: some value some_sub_object: other_key_1: other value other_key_2: false instruments: - id: 006c497d-8f50-4104-a204-b73d0a937486 payment_method: credit_card payment_wallet: direct payment_provider: adyen inventory_transaction.items_received: description: > Some items have been successfully received by another fulfillment location in the context of inventory transfer. **Idempotency key:** `id` value: tenant: businessname name: inventory_transaction.items_received published_at: '2010-01-01T12:00:00.000Z' payload: id: 1fa2c648-f954-4775-a5fc-91f4a07902a6 fulfillment_location_id: US01 associate_id: xa089300ecb04916b9b41bd7eab2a587 stock_location_name: Main processed_at: '2010-01-01T12:00:00.000Z' shipment_ref: 3f2e71b6-e700-4573-8545-c46b9e0961a0 order_ref: 3f2e71b6-e700-4573-8545-c46b9e0961a0 asn_id: d4956f90-eadf-4318-adf6-98ac4d6b2428 chunk_number: 7 total_chunks: 8 items: - product_id: '10000233' quantity: 10 external_identifiers: ean13: ean-43jfdf823h4sdf3423 gtin: gtin-43jfdf823h4sdf3423 - product_id: '10000234' quantity: 5 external_identifiers: ean13: ean-jsdf823h4lsdfjs439 gtin: gtin-jsdf823h4lsdfjs439 inventory_transaction.items_ready_for_handover: description: > Some items have been successfully packed and ready for handover in the context of inventory transfer. See the [Stock locations](/newstore-cloud/newstore.html#stock-locations) resource manage stock locations in your stores. **Idempotency key:** `id` and `chunk_number`. value: tenant: businessname name: inventory_transaction.items_ready_for_handover published_at: '2010-01-01T12:00:00.000Z' payload: id: 1fa2c648-f954-4775-a5fc-91f4a07902a6 order_id: 3f2e71b6-e700-4573-8545-c46b9e0961a0 order_ref: e700-4573-8545-c46b9e0961a0 origin_id: US01 destination_id: US02 associate_id: xa089300ecb04916b9b41bd7eab2a587 stock_location_name: Main processed_at: '2010-01-01T12:00:00.000Z' chunk_number: 7 total_chunks: 8 items: - product_id: '10000233' quantity: 10 external_identifiers: ean13: ean-43jfdf823h4sdf3423 gtin: gtin-43jfdf823h4sdf3423 - product_id: '10000234' quantity: 5 external_identifiers: ean13: ean-jsdf823h4lsdfjs439 gtin: gtin-jsdf823h4lsdfjs439 inventory_transaction.asn_created: description: > [Advanced shipment notification](https://docs.newstore.com/docs/glossary#advance-shipment-notice) created for an inventory transfer. See the [Stock locations](/newstore-cloud/newstore.html#stock-locations) resource to manage stock locations in your stores. **Note:** This event will be emitted when an ASN is created on NewStore platform due to a Transfer from the store to another store or a DC. It is **not** emitted when a shipment from DC is injected from the ERP to the NewStore platform. **Idempotency key:** `id` and `chunk_number`. value: tenant: businessname name: inventory_transaction.asn_created published_at: '2010-01-01T12:00:00.000Z' payload: id: 1fa2c648-f954-4775-a5fc-91f4a07902a6 origin_id: US01 destination_id: US02 shipment_date: '2020-01-02T12:00:00.000Z' shipment_ref: e700-4573-8545-c46b9e0961a0 purchase_order_number: PO ac31345sdf945345 transfer_order_ref: TO ac31345sdf945345 transfer_transaction_ref: TT ac31345sdf945345 transfer_order_id: '11111111' transfer_transaction_id: '22222' created_at: '2020-01-01T12:00:00.000Z' chunk_number: 1 total_chunks: 2 items: - product_id: '10000233' quantity: 10 external_identifiers: ean13: ean-43jfdf823h4sdf3423 gtin: gtin-43jfdf823h4sdf3423 - product_id: '10000234' quantity: 5 external_identifiers: ean13: ean-jsdf823h4lsdfjs439 gtin: gtin-jsdf823h4lsdfjs439 inventory_transaction.asn_closed: description: > [Advanced shipment notification](https://docs.newstore.com/docs/glossary#advance-shipment-notice) closed on New Store Omnichannel Cloud. **Idempotency key:** `asn_closed.{id}`. value: tenant: businessname name: inventory_transaction.asn_closed published_at: '2010-01-01T12:00:00.000Z' payload: id: 1fa2c648-f954-4775-a5fc-91f4a07902a6 inventory_transaction.adjustment_created: description: > Some items have been successfully [adjusted](https://docs.newstore.net/product/glossary#glossary-inventory-adjustment) in a store in the context of an inventory adjustment transaction. See the [Stock locations](/newstore-cloud/newstore.html#stock-locations) resource to manage stock locations in your store. **Idempotency key:** `id` and `chunk_number`. value: tenant: businessname name: inventory_transaction.adjustment_created published_at: '2010-01-01T12:00:00.000Z' payload: id: 1fa2c648-f954-4775-a5fc-91f4a07902a6 fulfillment_node_id: US01 adjustment_type: Damaged adjustment_reason: Stained origin_stock_location_name: Main destination_stock_location_name: Damaged note: Damage details associate_id: 11af87aa-2b6c-474d-9a68-719a34e55711 processed_at: '2020-01-01T12:00:00.000Z' chunk_number: 1 total_chunks: 2 items: - product_id: '10000233' quantity: 10 external_identifiers: ean13: ean-43jfdf823h4sdf3423 gtin: gtin-43jfdf823h4sdf3423 - product_id: '10000234' quantity: 5 external_identifiers: ean13: ean-jsdf823h4lsdfjs439 gtin: gtin-jsdf823h4lsdfjs439 inventory_transaction.transfer_order_created: description: > A new Transfer Order was created internally in NewStore Omnichannel Cloud. **Idempotency key:** `id` and `chunk_number`. value: tenant: businessname name: inventory_transaction.transfer_order_created published_at: '2010-01-01T12:00:00.000Z' payload: id: 06bcf66b-660a-481e-810a-cb4d8f933995 origin_id: US01 destination_id: US02 external_ref: '123456789' origin_stock_location: main created_at: '2010-01-01T12:00:00.000Z' chunk_number: 1 total_chunks: 1 items: - product_id: '10000233' quantity: 10 external_identifiers: ean13: ean-43jfdf823h4sdf3423 gtin: gtin-43jfdf823h4sdf3423 - product_id: '10000234' quantity: 5 external_identifiers: ean13: ean-jsdf823h4lsdfjs439 gtin: gtin-jsdf823h4lsdfjs439 inventory_transaction.transfer_order_closed: description: | A Transfer Order was closed on NewStore Omnichannel Cloud. **Idempotency key:** `id`. value: tenant: businessname name: inventory_transaction.transfer_order_closed published_at: '2010-01-01T12:00:00.000Z' payload: id: 06bcf66b-660a-481e-810a-cb4d8f933995 external_ref: '123456789' inventory_count.items_counted: description: > An inventory count has been completed in a fulfillment location. An inventory count can be of 2 types: full or partial. **Note:** This event is emitted for both partial (cycle) and full counts. **Idempotency key:** concatenate `id` and `chunk_number`. value: tenant: businessname name: inventory_count.items_counted published_at: '2010-01-01T12:00:00.000Z' payload: id: 1fa2c648-f954-4775-a5fc-91f4a07902a6 count_type: cycle_count fulfillment_location_id: US01 associate_id: xa089300ecb04916b9b41bd7eab2a587 stock_location_name: Main due_date: '2017-10-30T12:14:30.193Z' started_at: '2017-10-30T12:14:30.193Z' completed_at: '2017-10-30T13:14:30.193Z' chunk_number: 1 total_chunks: 2 external_id: '10000011' items: - product_id: '10000233' stock_on_hand: 10 count: 9 delta: -1 external_identifiers: ean13: ean-43jfdf823h4sdf3423 gtin: gtin-43jfdf823h4sdf3423 - product_id: '10000234' stock_on_hand: 0 count: 0 delta: 0 external_identifiers: ean13: ean-jsdf823h4lsdfjs439 gtin: gtin-jsdf823h4lsdfjs439 customer.created: description: > The [customer](https://docs.newstore.com/docs/glossary#consumer) has been successfully created in the NewStore Omnichannel Cloud. See the [Customers](/newstore-cloud/newstore.html#customers) resource and the [customer lifecycle](https://docs.newstore.com/docs/customer-lifecycle-bpm) for more information about the possible next events to expect. **Idempotency key:** `id` value: tenant: businessname name: customer.created published_at: '2010-01-01T12:00:00.000Z' payload: id: 8d249e38-d9b5-40ce-bdb7-c2767ba35bca email: johndoe@example.com first_name: John last_name: Doe phone: '07534706323' source: location_id: US03 associate_id: fe203100e1e2416ba6932d1561ccc380 associate_name: Jane Doe associate_email: some@qa2.com created_at: '2018-07-06T11:56:34.712Z' extended_attributes: - name: Ext. attribute one value: '1234567890' - name: Ext. attribute two value: 'false' - name: Ext. attribute three value: Some value customer.updated: description: > The [customer's](https://docs.newstore.com/docs/glossary#consumer) information has been updated in the NewStore Omnichannel Cloud. See the [Customers](/newstore-cloud/newstore.html#customers) resource and the [customer lifecycle](https://docs.newstore.com/docs/customer-lifecycle-bpm) for more information about the possible next events to expect. **Idempotency key:** `id` and `revision` value: tenant: businessname name: customer.updated published_at: '2010-01-01T12:00:00.000Z' payload: id: 8d249e38-d9b5-40ce-bdb7-c2767ba35bca email: johndoe@example.com first_name: John last_name: Doe phone: '07534706323' source: location_id: US03 associate_id: fe203100e1e2416ba6932d1561ccc380 associate_name: Jane Doe associate_email: some@qa2.com updated_at: '2018-07-06T11:56:34.712Z' extended_attributes: - name: Ext. attribute one value: '1234567890' - name: Ext. attribute two value: 'false' - name: Ext. attribute three value: Some value - name: Ext. attribute four value: '1999-09-19' revision: 2 customer.address_created: description: > A new [customer](https://docs.newstore.com/docs/glossary#consumer) address has been created in the NewStore Omnichannel Cloud. See the [Customers](/newstore-cloud/newstore.html#customers) resource and the [customer lifecycle](https://docs.newstore.com/docs/customer-lifecycle-bpm) for more information about the possible next events to expect. **Idempotency key:** `id` value: tenant: businessname name: customer.address_created published_at: '2010-01-01T12:00:00.000Z' payload: id: 8d249e38-d9b5-40ce-bdb7-c2767ba35bca customer_id: 616a60f6-c042-4700-b045-51e64a1b330a type: billing first_name: Jane last_name: Doe company: Newstore GmbH address_line_1: Potsdamer Str. 123 address_line_2: 2nd Floor address_line1: Potsdamer Str. 123 address_line2: 2nd Floor zip_code: '12345' city: Berlin state: Berlin country_code: DE contact_phone: '+49179123456' created_at: '2010-01-01T12:00:00.000Z' customer.address_updated: description: > The [customer's](https://docs.newstore.com/docs/glossary#consumer) address information has been updated in the NewStore Omnichannel Cloud. See the [Customers](/newstore-cloud/newstore.html#customers) resource and the [customer lifecycle](https://docs.newstore.com/docs/customer-lifecycle-bpm) for more information about the possible next events to expect. **Idempotency key:** `id` + `revision` value: tenant: businessname name: customer.address_updated published_at: '2010-01-02T12:00:00.000Z' payload: id: 8d249e38-d9b5-40ce-bdb7-c2767ba35bca customer_id: 616a60f6-c042-4700-b045-51e64a1b330a type: billing first_name: Jane last_name: Doe company: nil address_line_1: Potsdamer Str. 123 address_line_2: 2nd Floor address_line1: Potsdamer Str. 123 address_line2: 2nd Floor zip_code: '12345' city: Berlin state: Berlin country_code: DE contact_phone: '+49179654321' created_at: '2010-01-01T12:00:00.000Z' customer_revision: 17 customer.address_deleted: description: > The [customer's](https://docs.newstore.com/docs/glossary#consumer) address was deleted in the NewStore Omnichannel Cloud. See the [Customers](/newstore-cloud/newstore.html#customers) resource and the [customer lifecycle](https://docs.newstore.com/docs/customer-lifecycle-bpm) for more information about the possible next events to expect. **Idempotency key:** `id` value: tenant: businessname name: customer.address_deleted published_at: '2010-01-01T12:00:00.000Z' payload: id: 8d249e38-d9b5-40ce-bdb7-c2767ba35bca customer_id: 616a60f6-c042-4700-b045-51e64a1b330a customer_revision: 19 employee.created: description: > A new employee has been successfully created in the NewStore Omnichannel Cloud. **Idempotency key:** `id` value: tenant: businessname name: employee.created published_at: '2021-01-01T12:00:00.000Z' payload: id: fe203100e1e2416ba6932d1561ccc380 email: johndoe@example.com first_name: John last_name: Doe is_active: true phone: '07534706323' store_id: e7f2403c-b220-4bb2-a8f9-64b85ee0a7a4 created_at: '2021-01-01T11:00:00.123Z' revision: 1 employee.updated: description: > The employee's information has been updated in the NewStore Omnichannel Cloud. **Idempotency key:** `id` + `revision` value: tenant: businessname name: employee.updated published_at: '2021-01-01T13:00:00.000Z' payload: id: fe203100e1e2416ba6932d1561ccc380 email: johndoe@example.com first_name: John last_name: Doe is_active: false phone: '07534706323' store_id: e7f2403c-b220-4bb2-a8f9-64b85ee0a7a4 created_at: '2021-01-01T12:00:00.123Z' updated_at: '2021-01-01T12:30:00.123Z' revision: 4 cash_drawer.transaction_completed: description: | Emitted when a draft cash transaction is marked as completed. **Idempotency key:** `id` value: tenant: businessname name: cash_drawer.transaction_completed published_at: '2010-01-01T12:00:00.000Z' payload: id: c7bb2b86-c7c3-4f73-a33f-5cbc230a71d4 store_id: '502' cash_drawer_id: 018777c2-a93e-4bb3-896c-136b906bb517 cash_drawer_external_id: US_NY_5_AVE associate_id: 6413f176305e4227af0693da492e7fb4 created_at: '2010-01-01T12:00:00.000Z' correlation_id: 8643117e-a832-46b0-a7d2-e346f8008741 transaction_kind: non_sale transaction_type: add_petty_cash order_id: 018777c2-a93e-4bb3-896c-136b906bb517 reason_code: 7080 amount_balance: value: 2.16 currency: USD cash_drawer.activity_recorded: description: > Emitted when a new activity is recorded for a cash drawer. In practice only activation and deactivation. **Idempotency key:** `id` value: tenant: businessname name: cash_drawer.activity_recorded published_at: '2010-01-01T12:00:00.000Z' payload: id: c7bb2b86-c7c3-4f73-a33f-5cbc230a71d4 store_id: '502' cash_drawer_id: 018777c2-a93e-4bb3-896c-136b906bb517 cash_drawer_external_id: US_NY_5_AVE associate_id: 6413f176305e4227af0693da492e7fb4 created_at: '2010-01-01T12:00:00.000Z' correlation_id: 8643117e-a832-46b0-a7d2-e346f8008741 activity: activation cash_drawer.float_defined: description: | Emitted when float was defined/adjusted in the cash drawer. **Idempotency key:** `id` value: tenant: businessname name: cash_drawer.float_defined published_at: '2010-01-01T12:00:00.000Z' payload: id: c7bb2b86-c7c3-4f73-a33f-5cbc230a71d4 store_id: '502' cash_drawer_id: 018777c2-a93e-4bb3-896c-136b906bb517 cash_drawer_external_id: US_NY_5_AVE associate_id: 6413f176305e4227af0693da492e7fb4 created_at: '2010-01-01T12:00:00.000Z' correlation_id: 8643117e-a832-46b0-a7d2-e346f8008741 float_balance: value: 2.16 currency: USD cash_drawer.count_submitted: description: | Emitted when an associate performs cash count. **Idempotency key:** `id` value: tenant: businessname name: cash_drawer.count_submitted published_at: '2010-01-01T12:00:00.000Z' payload: id: c7bb2b86-c7c3-4f73-a33f-5cbc230a71d4 store_id: '502' cash_drawer_id: 018777c2-a93e-4bb3-896c-136b906bb517 cash_drawer_external_id: US_NY_5_AVE associate_id: 6413f176305e4227af0693da492e7fb4 created_at: '2010-01-01T12:00:00.000Z' correlation_id: 8643117e-a832-46b0-a7d2-e346f8008741 reason: intra_day_balance counted_balance: value: 2.16 currency: USD cash_drawer.drawer_created: description: | Emitted when a cash drawer is created. **Idempotency key:** `id` value: tenant: businessname name: cash_drawer.drawer_created published_at: '2010-01-01T12:00:00.000Z' payload: id: c7bb2b86-c7c3-4f73-a33f-5cbc230a71d4 store_id: '502' cash_drawer_external_id: US_NY_5_AVE associate_id: 6413f176305e4227af0693da492e7fb4 created_at: '2010-01-01T12:00:00.000Z' cash_drawer.drawer_updated: description: | Emitted when a cash drawer is updated. **Idempotency key:** `id` + `revision` value: tenant: businessname name: cash_drawer.drawer_updated published_at: '2010-01-01T12:00:00.000Z' payload: id: c7bb2b86-c7c3-4f73-a33f-5cbc230a71d4 store_id: '502' cash_drawer_external_id: US_NY_5_AVE associate_id: 6413f176305e4227af0693da492e7fb4 updated_at: '2010-01-01T12:00:00.000Z' decomissioned: true revision: 3 gift_card.deactivated: description: | Emitted when a gift card is deactivated. **Idempotency key:** `id` + `deactivated_at` value: tenant: businessname name: gift_card.deactivated published_at: '2010-01-01T12:00:00.000Z' payload: id: '987604545054' deactivated_at: '2010-01-01T10:00:00.000Z' store_id: '502' clienteling.optin_changed: description: > Emitted when the clienteling opt in state for a customer changes. **Idempotency key:** Event ID value: tenant: businessname name: clienteling.optin_changed published_at: '2025-01-01T12:00:00.000Z' payload: customer_id: 616a60f6-c042-4700-b045-51e64a1b330a phone_number: '+14155552671' opted_out: false opted_out_at: null opted_in: NYC_01: opt_in_state: waiting opt_in_state_modified_at: '2025-01-01T12:00:00.000Z' BROOKLYN_01: opt_in_state: accepted opt_in_state_modified_at: '2025-01-01T12:00:00.000Z' reservation.created: description: | Emitted when a reservation is created **Idempotency key:** `id`. value: tenant: businessname name: reservation.created published_at: '2010-01-01T12:00:00.000Z' payload: id: 0198ea7c-c482-796f-b98a-81c6824b3087 external_id: 4B3087 created_at: '2025-08-27T07:45:02.100Z' expires_at: '2025-08-28T07:45:02.082Z' associate_id: 313c668a1a0742408abdab9ba7dc0f55 customer_profile_id: aa156f58-5bc2-462a-ba6f-061dce3ee767 location_id: US01 items: - id: 0198ea7c-c497-7a10-b9e1-7b2c813f24ed product_id: '111101' status: RESERVED - id: 0198ea7c-c498-736d-8c30-63fccc74ff85 product_id: '111101' status: RESERVED - id: 0198ea7c-c499-7676-8c8f-aaeed6a27aad product_id: '111002' status: RESERVED status: RESERVED reservation.updated: description: > Emitted when a reservation is updated. **Note:** This event will be emitted every time a reservation or reservation items changes its status. **Idempotency key:** `idempotency_key`. value: tenant: businessname name: reservation.updated published_at: '2010-01-01T12:00:00.000Z' payload: id: 0198ea84-fc7e-7024-8332-5e4cc7d5fa76 updated_at: '2025-08-27T07:54:00.741Z' items: - id: 0198ea84-fc92-7d59-b6d7-6d848e025579 product_id: '111001' status: CONVERTED updated_at: '2025-08-27T07:54:00.741Z' - id: 0198ea84-fc93-7288-90ae-6c63d7054cee product_id: '111002' status: CONVERTED updated_at: '2025-08-27T07:54:00.741Z' idempotency_key: >- 0198ea84-fc7e-7024-8332-5e4cc7d5fa76:bdd5309a15db02b9542732fe1303977a2a01e755b7a1a70729cdeb3c1716d9b7 status: CONVERTED schema: title: Public event description: >- The public event hold information about the tenant, a name to identify the event, a timestamp as well as the provided payload. type: object required: &ref_49 - tenant - name - published_at - payload properties: &ref_50 tenant: description: The tenant name. type: string name: description: The name of the external event. type: string enum: - fulfillment_request.assigned - fulfillment_request.items_completed - fulfillment_request.items_failed - fulfillment_request.items_ready_for_handover - order.created - order.opened - order.shipped - order.completed - order.cancelled - order.items_swapped - order.items_cancelled - order.items_on_hold - order.serial_numbers_added - order.customer_profile_amended - invoice.created - return.processed - refund_request.issued - payment_account.amount_authorized - payment_account.amount_captured - payment_account.amount_refunded - payment_account.amount_voided - inventory_transaction.items_received - inventory_transaction.items_ready_for_handover - inventory_transaction.asn_created - inventory_transaction.asn_closed - inventory_transaction.adjustment_created - inventory_transaction.transfer_order_created - inventory_transaction.transfer_order_closed - inventory_count.items_counted - customer.created - customer.updated - customer.address_created - customer.address_updated - customer.address_deleted - employee.created - employee.updated - cash_drawer.activity_recorded - cash_drawer.count_submitted - cash_drawer.drawer_created - cash_drawer.drawer_updated - cash_drawer.float_defined - cash_drawer.transaction_completed - gift_card.deactivated - clienteling.optin_changed - reservation.created - reservation.updated published_at: description: UTC timestamp indicating when this event was generated. format: date-time type: string payload: description: Content of the event defined by the 'name' property. type: object anyOf: - title: order.created description: >- `order.created` is sent directly after order placement. It contains all order and order item details. type: object required: &ref_3 - id - external_id - created_at - placed_at - channel_type - channel - is_exchange - is_historical - price_method - currency - tax_exempt - subtotal - discount_total - shipping_total - shipping_tax - tax_total - grand_total - items properties: &ref_56 id: &ref_4 type: string description: Unique ID for the order. external_id: &ref_5 type: string description: Unique human-friendly identifier for the order. created_at: &ref_6 type: string format: date-time description: >- The UTC time the order was created in the NewStore system. placed_at: &ref_7 type: string format: date-time description: >- The UTC time the order was placed in the source system. associate_id: &ref_8 type: string description: >- The identifier of the associate who processed the order at the store. maxLength: 256 associate_email: &ref_9 type: string description: >- The email address of the associate who processed the order at the store. maxLength: 256 channel_type: &ref_10 type: string enum: - web - mobile - store description: >- Reference to the channel type in which the order was placed. channel: &ref_11 type: string description: Label of the channel in which the order was placed. demand_location_id: &ref_12 type: string description: >- Contains the location id of the store where the order was placed. is_exchange: &ref_13 type: boolean description: >- Set to true, if the order is a result of an exchange. exchanges: &ref_14 description: Return information related to exchanges. type: array maxItems: 100 items: &ref_51 type: object required: - order_id - return_id properties: order_id: type: string description: >- Identifier of the original order that was exchanged. return_id: type: string description: Identifier of the return. customer_email: &ref_15 type: string description: >- Email of the customer who created this order. Always present for orders with channel_type 'web'. customer_id: &ref_16 type: string description: >- Identifier of the customer who created this order. Always present for orders with channel_type 'web'. external_customer_id: &ref_17 type: string description: >- Identifier used in the external system to identify the customer. is_historical: &ref_18 type: boolean description: >- Indicates if the order was fulfilled by an external system. discounts: &ref_19 type: array description: List of coupons used in the order. items: type: object description: A discount coupon applied to the order. required: &ref_52 - trigger - discount_id - coupon_code properties: &ref_53 trigger: type: string enum: - coupon description: Trigger of the discount. maxLength: 36 discount_id: type: string description: >- Unique identifier of the discount applied to the order. maxLength: 36 coupon_code: type: string description: Coupon code applied to the order. maxLength: 256 billing_address: &ref_20 description: >- The customer's billing address for this order. Always present for orders with channel_type 'web'. type: object required: &ref_0 - id - last_name - address_line_1 - country properties: &ref_1 id: type: string description: Unique identifier of the address. title: type: string description: Personal title; usually in front of the name. suffix: type: string description: >- Name suffix; intended to be appended after the name. salutation: type: string description: >- Appropriate salutation phrase. For example Mr., Mrs. first_name: type: string description: Contact's first name. last_name: type: string description: Contact's last name. address_line_1: type: string description: First address line. address_line_2: type: string description: Second address line. address_line1: type: string description: >- First address line. This attribute is deprecated and will be removed in the future. Please use 'address_line_1' instead. address_line2: type: string description: >- Second address line. This attribute is deprecated and will be removed in the future. Please use 'address_line_2' instead. zip_code: type: string description: Postal code. city: type: string description: City name. state: type: string description: State name. country: type: string description: ISO 3166-1 alpha-2 country code. phone: type: string description: Phone number for delivery-related communication. shipping_address: &ref_21 description: >- The customer's shipping address for this order. Always present for orders with channel_type 'web'. type: object required: *ref_0 properties: *ref_1 price_method: &ref_22 description: >- In US, taxes are usually excluded from customer-facing prices (catalog prices, discount amounts, etc.), and added after computing the subtotals. In this case, price_method is set to tax_excluded. In EU, taxes are usually included in customer-facing prices. When this price method is used, price_method is set to tax_included. type: string enum: - tax_included - tax_excluded subtotal: &ref_23 type: number minimum: 0 description: >- Sum of all item prices before discount, can be with taxes (if price_method=tax_included) or without taxes (if price_method=tax_excluded). discount_total: &ref_24 type: number minimum: 0 description: >- Total discount amount (monetary value) applied to this order. shipping_total: &ref_25 type: number minimum: 0 description: >- Sum of all shipping prices before discount, can be with taxes (if price_method=tax_included) or without taxes (if price_method=tax_excluded). shipping_tax: &ref_26 type: number minimum: 0 description: Sum of all shipping taxes. tax_total: &ref_27 type: number minimum: 0 description: >- Sum of product taxes + sum of taxes for value added services (shipping, gift-wrapping, etc.). grand_total: &ref_28 type: number minimum: 0 description: >- Final price the consumer has to pay for the entire order (after discounts & tax calculation). currency: &ref_29 type: string description: >- The currency billed to the consumer, using ISO-4217 Currency Code. tax_strategy: &ref_30 type: string description: >- The tax strategy used for calculation (fixedrate, avalara, fixed_rate_per_country). tax_exempt: &ref_31 type: boolean description: If true, the order is tax exempt. extended_attributes: &ref_32 description: >- A collection of key-value-pairs for custom properties on order level. type: array maxItems: 100 items: &ref_2 type: object required: - name - value maxProperties: 2 properties: name: type: string maxLength: 100 value: type: string maxLength: 8192 items: &ref_33 type: array description: >- List containing items in the order; one list index equals one item. minItems: 1 items: type: object required: - id - list_price - item_discounts - order_discounts - quantity - tax properties: id: type: string description: >- Unique identifier of the item in the order. This identifier is used in all events that notify about item changes. item_type: type: string description: >- The type of the item, e.g. product, gift-wrapping etc. parent_item_id: type: string description: >- The unique identifier of the parent item if this is an addon item. product_id: type: string description: The identifier of the corresponding product. pricebook_id: type: string description: Identifier of the pricebook used. pricebook_price: type: number minimum: 0 description: >- Original price from the product catalog that the customer saw in the shopping cart, can be with taxes (if price_method=tax_included) or without taxes (if price_method=tax_excluded) list_price: type: number minimum: 0 description: >- Price from default pricebook (e.g. MSRP, or UVP in germany), can be with taxes (if price_method=tax_included) or without taxes (if price_method=tax_excluded). overridden_price: type: number minimum: 0 description: >- The manually overridden price for this item, if applicable. Can be with taxes (if price_method=tax_included) or without taxes (if price_method=tax_excluded). override_reason: type: string description: >- The reason for the price override, if applicable. override_reason_type: type: string description: >- Specifies whether the price override reason is selected from predefined reason codes (`reason_code`) or provided as a custom free-text reason (`custom_reason`). Note: for orders before 23 April 2026, the deprecated value `custom_discount` is possible. item_discounts: type: number minimum: 0 description: >- Sum (monetary value) of item level discounts applied on this item. order_discounts: type: number minimum: 0 description: >- Sum (monetary value) of order level discounts applied on this item. tax: type: number minimum: 0 description: The item tax amount. tax_provider_details: description: A list of tax provider details on item level. type: array maxItems: 100 required: &ref_34 - amount - rate items: &ref_35 type: object properties: name: type: string maxLength: 256 description: Tax provider specific name of the tax. amount: type: number minimum: 0 description: Amount of this tax. rate: type: number minimum: 0 description: Rate of this tax. tax_class: type: string maxLength: 256 description: Tax classification identifier for the item. quantity: type: number minimum: 1 maximum: 1 description: The sold quantity (always 1). status: type: string description: >- Current status of the item (e.g. created, opened). discounts: type: array description: >- Information about discounts applied to the item. items: type: object description: A discount applied to an item. required: &ref_54 - id - price_adjustment - action - value - level properties: &ref_55 id: type: string description: >- ID of the discount rule that is applied. If no discount rule is applied (e.g. manual price adjustment), the value is a generated ID. maxLength: 36 price_adjustment: description: >- Monetary amount which is subtracted from the item price. type: number action: description: >- Type of promotion (for example 'fixed' or 'percentage'). type: string value: description: >- Original discount value (for example '10' in case of a 10% discount). type: number level: description: >- Discount level (for example 'item', 'order' or 'shipping' for an item level discount). type: string coupon_code: type: string description: >- The coupon code associated with this discount. maxLength: 256 external_ref: description: >- Reference to the discount in the external system. type: string maxLength: 256 reason: description: The name of the promotion. type: string fulfillment_location_id: type: string description: >- The location (warehouse or store) where the item is going to be fulfilled or was fulfilled. extended_attributes: description: >- A collection of key-value-pairs for custom properties on item level. type: array maxItems: 100 items: *ref_2 external_identifiers: description: >- A collection of key-value-pairs for external identifiers (like sku, epc etc.). type: object maxProperties: 105 properties: &ref_36 serial_number: description: Serial number for the order item. type: string epc: description: >- EPC (Electronic Product Code) for order item type: string external_item_id: type: string description: External id of the product. additionalProperties: &ref_37 description: >- Any external identifier as specified in the catalog data, e.g. SKU, EAN and others. type: string shipping_service_level: type: string description: >- The shipping service level of the order. It is configured as part of each shipping option. is_preorder: type: boolean description: Indicates if the item was pre-ordered. future_fulfillment_location_id: type: string maxLength: 256 description: >- Fulfillment location ID where a future allocation was created for this sales order item. shipping_method: type: string maxLength: 256 description: >- Indicates the type of shipping used for the order item. - title: order.opened description: >- `order.opened` is sent after the grace period. It contains all order and order item details. Any order changes during grace period will be reflected in the event payload. type: object required: *ref_3 properties: &ref_57 id: *ref_4 external_id: *ref_5 created_at: *ref_6 placed_at: *ref_7 associate_id: *ref_8 associate_email: *ref_9 channel_type: *ref_10 channel: *ref_11 demand_location_id: *ref_12 is_exchange: *ref_13 exchanges: *ref_14 customer_email: *ref_15 customer_id: *ref_16 external_customer_id: *ref_17 is_historical: *ref_18 discounts: *ref_19 billing_address: *ref_20 shipping_address: *ref_21 price_method: *ref_22 subtotal: *ref_23 discount_total: *ref_24 shipping_total: *ref_25 shipping_tax: *ref_26 tax_total: *ref_27 grand_total: *ref_28 currency: *ref_29 tax_strategy: *ref_30 tax_exempt: *ref_31 extended_attributes: *ref_32 items: *ref_33 - title: order.completed description: >- `order.completed` is sent when all order items are fulfilled (or cancelled). Note that payment processing might not be complete yet. type: object required: &ref_58 - id - items properties: &ref_59 id: type: string description: Unique ID for the order. capture_type: type: string description: >- Indicates the capture type of the order. If the order has been placed in the Associate App or any mPOS then the capture type is pos. If the order has been injected then the capture_type is injection. items: type: array description: >- List containing items in the order; one list index equals one item. minItems: 1 items: type: object required: - id - product_id - quantity - status - fulfillment_location_id - shipping_service_level properties: id: type: string description: >- Unique identifier of the item in the order. This identifier is used in all events that notify about item changes. product_id: type: string description: The identifier of the corresponding product. quantity: type: number minimum: 1 maximum: 1 description: The sold quantity (always 1). status: type: string description: >- Current status of the item (e.g. shipped, cancelled). fulfillment_location_id: type: string description: >- The location (warehouse or store) where the item is going to be fulfilled or was fulfilled. shipping_service_level: type: string description: >- The shipping service level of the order. This the service_level_identifier configured as part of each shipping option. shipping_method: type: string maxLength: 256 description: >- Indicates the type of shipping used for the order item. - title: order.cancelled description: >- `order.cancelled` is sent when the whole order is cancelled. type: object required: &ref_60 - id - items properties: &ref_61 id: type: string description: Unique ID for the order. cancellation_reason: type: string description: >- The reason the order was cancelled, i.e insufficient_stock, cancellation_request etc. capture_type: type: string description: >- Indicates the capture type of the order. If the order has been placed in the Associate App or any mPOS then the capture type is pos. If the order has been injected then the capture_type is injection. items: type: array description: >- List containing items in the order; one list index equals one item. minItems: 1 items: type: object required: - id - product_id - quantity - status properties: id: type: string description: >- Unique identifier of the item in the order. This identifier is used in all events that notify about item changes. product_id: type: string description: The identifier of the corresponding product. quantity: type: number minimum: 1 maximum: 1 description: The quantity that was cancelled. status: type: string description: Current status of the item (cancelled). fulfillment_location_id: type: string description: >- ID of fulfillment node that tried to fulfill the order. shipping_service_level: type: string description: >- The shipping service level of the order. It is configured as part of each shipping option. shipping_method: type: string maxLength: 256 description: >- Indicates the type of shipping used for the order item. - title: order.items_cancelled description: >- `order.items_cancelled` is sent whenever one or more order items are cancelled. type: object required: &ref_62 - id - items properties: &ref_63 id: type: string description: Unique ID for the order. items: type: array description: List containing cancelled items of the order. minItems: 1 items: type: object description: A cancelled item in quantity=1. required: - id - product_id - cancellation_reason properties: id: type: string description: >- Unique identifier of the item in the order (two items for the same product will have different identifiers). This identifier is used in all events that notify about item changes. product_id: type: string description: The identifier of the corresponding product. fulfillment_location_id: type: string description: >- Identifier of the fulfillment node where this item was supposed to be delivered from. This field is omitted when no stock has been allocated for the item. cancellation_reason: type: string description: >- Reason for the item's cancellation, i.e insufficient_stock, cancellation_request etc. - title: order.items_on_hold description: >- `order.items_on_hold` is sent whenever one or more order items have been put on hold, because their fulfillment could not proceed. type: object required: &ref_64 - id - external_id - items properties: &ref_65 id: type: string description: Unique ID for the order. external_id: type: string description: Unique human-friendly identifier for the order. revision: type: integer description: >- Revision number of the order. Incremented by 1 with every order update. items: type: array description: List containing order items in status 'on_hold'. minItems: 1 items: type: object description: An on_hold item in quantity=1. required: - id properties: id: type: string description: >- Unique identifier of the item in the order (two items for the same product will have different identifiers). This identifier is used in all events that notify about item changes. product_id: type: string description: The identifier of the corresponding product. fulfillment_location_id: type: string description: >- Identifier of the fulfillment node where this item was supposed to be delivered from. This field is omitted when no stock has been allocated for the item. reason: type: string description: >- Reason code for the cancellation. For example 'insufficient_stock' or 'failed_fulfillment_node_mapping'. - title: order.serial_numbers_added description: >- `order.serial_numbers_added` is sent whenever one or more items in an order have a serial number assigned. type: object required: &ref_66 - id - items - revision properties: &ref_67 id: type: string description: Unique ID for the order. items: type: array description: >- List containing the serial numbers assigned to items in an order. minItems: 1 items: type: object description: An item with a serial number assigned. required: - id - serial_number properties: id: type: string description: >- Unique identifier of the item in the order (two items for the same product will have different identifiers). This identifier is used in all events that notify about item changes. serial_number: type: string description: >- The serial number which is assigned to a specific order item. epc: type: string description: EPC code matching with serial number. revision: type: integer description: The revision of the order. - title: order.customer_profile_amended description: >- `order.customer_profile_amended` is sent whenever a customer profile has been amended to an order. type: object required: &ref_68 - order_id - customer_id - customer_email properties: &ref_69 order_id: type: string description: Unique ID for the order. customer_id: type: string description: >- Unique ID of the customer who was amended to this order. customer_email: type: string format: email description: Email of the customer who was amended to this order. - title: order.items_swapped description: >- `order.items_swapped` is sent when one order items is swapped against another product. Prices are not affected by an item swap type: object required: &ref_70 - id - associate_id - replaced_at - replaced_product_id - replacement_product_id - replaced_item_id - replacement_item_id properties: &ref_71 id: type: string description: Unique ID for the sales order. associate_id: type: string description: >- The identifier of the associate who swapped the items. replaced_at: type: string format: date-time description: The UTC time the item was swapped. replaced_product_id: type: string description: >- The identifier of the corresponding replaced product. replacement_product_id: type: string description: >- The identifier of the corresponding replacement product. replaced_item_id: type: string description: >- The unique identifier of the corresponding replaced product in the corresponding sales order. replacement_item_id: type: string description: >- The unique identifier of the corresponding replacement product in the corresponding sales order. reason: type: string description: The reason of the swap. reason_notes: type: string description: Notes about the reason of the swap. - title: invoice.created type: object required: &ref_72 - id - external_id - order_id - created_at - currency - discount_total - shipping_total - tax_total - grand_total properties: &ref_73 id: type: string description: Unique ID for the invoice. external_id: type: string description: Unique human-friendly identifier for the invoice. order_id: type: string description: The unique identifier to the referenced order. created_at: type: string format: date-time description: >- The UTC time the invoice was created in the NewStore system. discount_total: type: number minimum: 0 description: >- Total discount amount (monetary value) applied to this order. shipping_total: type: number minimum: 0 description: >- Sum of all shipping prices before discount, can be with taxes (if price_method=tax_included) or without taxes (if price_method=tax_excluded). tax_total: type: number minimum: 0 description: >- Sum of product taxes + sum of taxes for value added services (shipping, gift-wrapping, etc.). grand_total: type: number minimum: 0 description: >- Final price the consumer has to pay for the entire order (after discounts & tax calculation). currency: type: string description: >- The currency billed to the consumer, using ISO-4217 Currency Code. invoice_url: type: string format: uri description: Link to the invoice document. tax_provider_details: description: A list of tax provider details on invoice level. type: array maxItems: 100 required: *ref_34 items: *ref_35 items: type: array description: >- List containing items in the invoice; one list index equals one item. minItems: 1 items: type: object required: - id - product_id properties: id: type: string description: Unique identifier of the item in the invoice. product_id: type: string description: The identifier of the corresponding product. product_name: type: string description: The name of the corresponding product. amount: type: number minimum: 0 description: >- Total amount the customer has to pay for this item (including taxes). tax: type: number minimum: 0 description: The item tax amount. item_discounts: type: number minimum: 0 description: >- Sum (monetary value) of item level discounts applied on this item. order_discounts: type: number minimum: 0 description: >- Sum (monetary value) of order level discounts applied on this item. - title: return.processed description: >- `return.processed` is sent when one or more items have been returned. Processing of the associated refund transaction might not be completed yet. type: object required: &ref_74 - id - returned_at - currency - total_refund_amount - total_refund_amount_adjusted - total_refund_excl_tax - total_refund_tax - return_location_id - items properties: &ref_75 id: type: string description: The id of the return. order_id: type: string description: >- The order id this return is related to. Order id is omitted for blind returns. blind_order_id: type: string description: >- The id of the order that was created to execute a blind return. Omitted if the return is not a blind return. external_order_id: type: string description: Unique human-friendly identifier for the order. returned_at: format: date-time type: string description: >- The UTC time the return was processed in the DC or store. total_refund_amount: type: number minimum: 0 description: >- Total cost of items in this return before adjustment due to return policy and existing refunds. total_refund_amount_adjusted: type: number minimum: 0 description: >- Total cost of items in this return after adjustment due to return policy and existing refunds. See 'refunded_amount' for the amount that was actually refunded. total_refund_excl_tax: type: number minimum: 0 description: Total cost of items in this return without taxes. total_refund_tax: type: number minimum: 0 description: Total tax of items in this return. refunded_amount: type: number minimum: 0 description: Actual refunded amount for this return. return_fee: type: number minimum: 0 description: The fee a consumer has to pay for a return. currency: type: string description: >- The currency used in processing this return, using ISO-4217 Currency Code. return_location_id: type: string description: >- The fulfillment location id where the return comes from. customer_id: type: string description: >- Contains the identifier of the customer who bought the items. customer_email: type: string description: >- Contains the email address of the customer who bought the items. associate_id: type: string description: >- Contains the identifier of the associate who processed the return. associate_email: type: string description: >- Contains the email address of the associate who processed the return. items: type: array minItems: 1 items: type: object required: - id - product_id - quantity - refund_amount - refund_amount_adjusted - refund_excl_tax - refund_tax properties: id: type: string description: >- The identifier of this returned item. It is the same identifier as used for this item in the original order. product_id: type: string description: The identifier of the corresponding product. item_type: type: string description: >- Type of the returned item. For example 'product' or 'shipping'. item_condition: type: string description: >- The condition of the item, checked while doing quality inspection. condition_code: type: integer description: The corresponding code for the item condition. return_reason: type: string description: The reason why this item was returned. return_code: type: integer description: The corresponding code for the return reason. refund_excl_tax: type: number minimum: 0 description: Refund amount of this item without taxes. refund_tax: type: number minimum: 0 description: Refund tax of this item. refund_amount: type: number minimum: 0 description: >- Refund amount of this item before adjustment due to return policy. refund_amount_adjusted: type: number minimum: 0 description: >- Refund amount of this item after adjustment due to return policy. adjustment_reason: type: string minimum: 0 description: >- The reason why the refund amount for this item was adjusted. quantity: type: number minimum: 1 maximum: 1 description: >- The returned quantity (always one item per line). external_identifiers: type: object description: >- Keys of this object are the names of external identifiers (sku, ean, epc, ...), and values are identifiers themselves. maxProperties: 105 properties: *ref_36 additionalProperties: *ref_37 - title: fulfillment_request.assigned description: >- `fulfillment_request.assigned` is sent when a fulfillment request for one or more items has been dispatched to a fulfillment location. type: object required: &ref_76 - id - order_id - logical_timestamp - created_at - fulfillment_location_id - items properties: &ref_77 id: type: string maxLength: 36 minLength: 36 description: The identifier for the fulfillment request. order_id: type: string description: The identifier of the order that was routed. logical_timestamp: description: >- Logical timestamp of the order. It is incremented on every update of an order across all orders for a tenant. type: integer created_at: description: >- The point in time when the fulfillment request was created (as ISO 8601 UTC timestamp) format: date-time type: string service_level: type: string description: >- Indicates the service level used for shipping the order, e.g. 'GROUND', 'STANDARD' or 'ECONOMY'. Depends on shipping provider settings. fulfillment_location_id: type: string description: >- The identifier of the corresponding fulfillment location. items: type: array description: >- List containing items in the fulfillment request; one list index equals one item. minItems: 1 items: type: object required: - id - product_id properties: id: type: string description: >- Unique identifier of the item in the order (two items for the same product will have different identifiers). This identifier is used in all events that notify about item changes. product_id: type: string description: >- Product ID of item which has been assigned to the fulfillment location. carrier_service: type: string description: >- Describes the speed and type of a shipment offered by a carrier, e.g. 'UPSStandard', 'FEDEX_2_DAY' or 'FEDEX_GROUND'. Depends on provider settings. - title: fulfillment_request.items_completed description: >- `fulfillment_request.items_completed` is sent when one or more items have been fulfilled, i.e., shipped or handed over to the customer. type: object required: &ref_78 - id - order_id - logical_timestamp - fulfillment_location_id - items properties: &ref_79 id: type: string maxLength: 36 minLength: 36 description: The identifier for the fulfillment request. order_id: type: string description: The identifier of the order that was routed. logical_timestamp: description: >- Logical timestamp of the order. It is incremented on every update of an order across all orders for a tenant. type: integer service_level: type: string description: >- Indicates the service level used for shipping the order, e.g. 'GROUND', 'STANDARD' or 'ECONOMY'. Depends on shipping provider settings. fulfillment_location_id: type: string description: >- The identifier of the corresponding fulfillment location. associate_id: type: string description: >- Identifier for the associate who fulfilled the order. items: type: array description: >- List containing fulfilled items of the fulfillment request. minItems: 1 items: type: object description: >- An item that was successfully shipped or handed over to the customer. required: - id - product_id properties: id: type: string description: >- Unique identifier of the item in the order (two items for the same product will have different identifiers). This identifier is used in all events that notify about item changes. product_id: type: string description: Identifier for the product. tracking_code: type: string minLength: 1 description: >- The code with which the shipment can be tracked. carrier: type: string minLength: 1 description: The carrier which ships the package(s). shipped_at: type: string format: date-time description: >- The timestamp indicating when the fulfillment location shipped the items. carrier_service: type: string description: >- Describes the speed and type of a shipment offered by a carrier, e.g. 'UPSStandard', 'FEDEX_2_DAY' or 'FEDEX_GROUND'. Depends on provider settings. - title: fulfillment_request.items_failed description: >- `fulfillment_request.items_failed` is sent when one or more items could not be fulfilled at the designated fulillment location. It includes the reason why the items could not be fulfilled. type: object required: &ref_80 - id - order_id - logical_timestamp - fulfillment_location_id - items properties: &ref_81 id: type: string maxLength: 36 minLength: 36 description: The identifier for the fulfillment request. order_id: type: string description: The identifier of the order that was routed. logical_timestamp: description: >- Logical timestamp of the order. It is incremented on every update of an order across all orders for a tenant. type: integer service_level: type: string description: >- Indicates the service level used for shipping the order, e.g. 'GROUND', 'STANDARD' or 'ECONOMY'. Depends on shipping provider settings. associate_id: type: string description: >- Identifier for the associate who fulfilled the order. fulfillment_location_id: type: string description: >- The fulfillment node that is requested to fulfill the request. items: type: array description: >- List containing items of the fulfillment request that failed to be fulfilled. minItems: 1 items: type: object description: >- An item that failed to be shipped or could not be handed over to the customer. required: - id - product_id properties: id: type: string description: >- Unique identifier of the item in the order (two items for the same product will have different identifiers). This identifier is used in all events that notify about item changes. product_id: type: string description: Identifier for the product. rejection_reason: type: string description: >- Reason code describing why the fulfillment request failed, e.g. 'no_inventory'. enum: - no_inventory - cancellation_request - cannot_fulfill - refused - damaged_items - rescinded fulfillment_rejection_reason: type: string description: >- Fulfillment process specific rejection reason code describing why the fulfillment request failed. This field is customer customizable unlike 'rejection_reason' which is NewStore internal. - title: fulfillment_request.items_ready_for_handover description: >- `fulfillment_request.items_ready_for_handover` have been packed and are ready for handover to the customer or the shipping provider type: object required: &ref_82 - id - order_id - logical_timestamp - fulfillment_location_id - service_level - items properties: &ref_83 id: type: string maxLength: 36 minLength: 36 description: The identifier for the fulfillment request. order_id: type: string description: The identifier of the order that was routed. logical_timestamp: description: >- Logical timestamp of the order. It is incremented on every update of an order across all orders for a tenant. type: integer service_level: type: string description: >- Indicates the service level used for shipping the order, e.g. 'GROUND', 'STANDARD' or 'ECONOMY'. Depends on shipping provider settings. fulfillment_location_id: type: string description: >- The identifier of the corresponding fulfillment location. associate_id: type: string description: >- Identifier for the associate who fulfilled the order. items: type: array description: >- List containing fulfilled items of the fulfillment request. minItems: 1 items: type: object description: >- A list of all items part of the fulfillment request with their product identifiers. required: - id - product_id properties: id: type: string description: >- Unique identifier of the item in the order (two items for the same product will have different identifiers). This identifier is used in all events that notify about item changes. product_id: type: string description: Identifier for the product. - title: refund_request.issued description: >- `refund_request.issued` is sent when a customer has been given an appeasement refund. It contains the reason and other details of the refund request. Processing of the refund transaction associated with this appeasement might not be completed yet. This event is not about financial refund transactions. They are covered in `payment_account.amount_refunded` type: object required: &ref_84 - id - order_id - payment_account_id - amount - currency - items properties: &ref_85 id: description: The unique identifier of this refund request. type: string maxLength: 36 minLength: 36 order_id: description: The unique identifier to the referenced order. type: string maxLength: 36 minLength: 36 payment_account_id: description: >- The unique identifier to the referenced payment account. type: string maxLength: 36 minLength: 36 requested_at: description: >- The point in time in ISO 8601 the refund was requested by a customer care representative. format: date-time type: string amount: description: The amount to be refunded to the customer. minimum: 0 type: number currency: description: ISO-4217 Currency Code. type: string reason_code: description: >- The reason for this refund, encoded as numeric code. Reasons and reason codes are taken from the configuration. type: integer return_reason: description: >- The reason this refund was requested, in natural language. type: string note: description: >- Contains extra information about this refund request. It is provided by the employee that triggered the request. type: string associate_id: description: >- The unique identifier of the associate who processed the request. type: string associate_email: description: >- The email of the associate who processed the request. type: string items: type: array items: type: object required: - id - type - amount properties: id: type: string description: The identifier of this refund request item. minLength: 36 maxLength: 36 type: type: string description: >- The type of the item to be refunded (for example 'product' or 'shipping'). amount: type: number description: The amount to be refunded for this item. - title: payment_account.amount_authorized description: >- `payment_account.amount_authorized` is sent when one or more authorized transactions have been processed successfully. type: object required: &ref_38 - id - order_id - transactions - instruments properties: &ref_90 id: &ref_39 description: The unique identifier of the payment account. type: string order_id: &ref_40 description: The unique identifier to the referenced order. type: string external_order_id: &ref_41 description: >- Unique human-friendly identifier for the referenced order. type: string transactions: &ref_42 description: >- Successful payment transactions performed on this account. type: array items: title: Payment Account transaction. type: object required: &ref_86 - id - instrument_id - amount - currency properties: &ref_87 id: description: The unique identifier of the transaction. type: string instrument_id: description: >- The unique identifier of the instrument on which the transaction was processed. type: string amount: description: The amount of the transaction. type: number currency: description: >- Currency of the transaction in ISO-4217 format. type: string minLength: 3 correlation_id: description: >- Identifies the operation that triggered this transaction. The value of this field can be the ID of several entities. e.g. refund_request or return. The 'extended_attributes' property might contain a 'reason_code' property that you can use to identify the type of operation. type: string extended_attributes: description: >- Payment metadata as received by the PSP. This field is not standardized. type: object instruments: &ref_43 description: >- The payment instruments used in the context of this payment account. type: array items: title: Payment Account instrument. description: >- A payment account instrument is a representation of a payment method for a specific psp. type: object required: &ref_88 - id - payment_provider properties: &ref_89 id: description: The unique identifier of the instrument. type: string payment_method: description: >- The payment method, e.g. cash, credit_card, gift_card, paypal. type: string payment_wallet: description: >- Source of the payment instrument, e.g. Apple Pay, Android Pay. type: string payment_provider: description: The payment service provider. type: string payment_origin: description: The source of the payment. type: string - title: payment_account.amount_captured description: >- `payment_account.amount_captured` is sent when one or more capture transactions have been processed successfully. type: object required: *ref_38 properties: &ref_91 id: *ref_39 order_id: *ref_40 external_order_id: *ref_41 transactions: *ref_42 instruments: *ref_43 - title: payment_account.amount_refunded description: >- `payment_account.amount_refunded` is sent when one or more refund transactions have been processed successfully. type: object required: *ref_38 properties: &ref_92 id: *ref_39 order_id: *ref_40 external_order_id: *ref_41 transactions: *ref_42 instruments: *ref_43 - title: payment_account.amount_voided description: >- `payment_account.amount_voided` is sent when one or more authorized transactions have been voided. type: object required: *ref_38 properties: &ref_93 id: *ref_39 order_id: *ref_40 external_order_id: *ref_41 transactions: *ref_42 instruments: *ref_43 - title: inventory_transaction.items_received description: >- Information about an inventory transaction (inventory was moved to a location). type: object required: &ref_94 - id - fulfillment_location_id - associate_id - processed_at - items properties: &ref_95 id: type: string description: Unique identifier of the inventory transaction. fulfillment_location_id: type: string description: >- Identifier of the corresponding fulfillment location. associate_id: type: string description: >- Identifier for the associate who processed the inventory transaction. stock_location_name: type: string description: Stock location name. processed_at: type: string format: date-time description: >- UTC timestamp when the inventory transaction was processed. shipment_ref: type: string nullable: true description: >- Shipment reference of the inventory transaction. Null when the items were received against an order reference only, without a shipment reference. order_ref: type: string nullable: true description: Order reference of the inventory transaction. asn_id: type: string description: >- The identifier of the ASN this transaction was received against. chunk_number: type: integer description: >- The number of the current chunk. This can only be an integer number between one and "total_chunks". total_chunks: type: integer description: >- Defines the total number of chunks that need to be processed. items: type: array description: The list of products from the inventory transaction. items: title: An inventory transaction item description: >- Information that identifies a product that was part of the inventory transaction. type: object required: &ref_44 - quantity properties: &ref_45 product_id: description: >- The unique identifier of the product that was part of the inventory transaction. type: string quantity: description: The quantity of the inventory item type: integer external_identifiers: type: object description: >- Keys of this object are the names of external identifiers (sku, ean, epc, ...), and values are identifiers themselves. - title: inventory_transaction.items_ready_for_handover description: >- Information about an inventory transfer (items ready to be moved from a location). type: object required: &ref_96 - id - order_id - order_ref - origin_id - destination_id - associate_id - chunk_number - total_chunks - processed_at - items properties: &ref_97 id: type: string description: Unique identifier of the transfer transaction. order_id: type: string description: The identifier of the transfer order. order_ref: type: string description: Order reference of the transfer order. origin_id: type: string description: >- Identifier of the fulfillment location items are transferred from. destination_id: type: string description: >- Identifier of the fulfillment location items are transferred to. associate_id: type: string description: >- Identifier for the associate who processed the transfer transaction. stock_location_name: type: string description: Stock location name. processed_at: type: string format: date-time description: >- UTC timestamp when the transfer transaction was processed. chunk_number: type: integer minimum: 1 description: >- The number of current chunk. This can only be a integer number between 1 and total_chunks. total_chunks: type: integer minimum: 1 description: >- Defines the total number of chunks that needs to be processed for a specific transfer transaction. items: type: array description: The list of products from the transfer transaction. items: title: An inventory transaction item description: >- Information that identifies a product that was part of the inventory transaction. type: object required: *ref_44 properties: *ref_45 - title: inventory_transaction.asn_created description: >- Information about an inventory transfer ASN(advanced shipment notification). type: object required: &ref_98 - id - origin_id - destination_id - shipment_date - shipment_ref - transfer_transaction_id - transfer_order_id - chunk_number - total_chunks - created_at - items properties: &ref_99 id: type: string description: Unique identifier of the transfer ASN. origin_id: type: string description: >- Identifier of the fulfillment location items are transferred from. destination_id: type: string description: >- Identifier of the fulfillment location items are transferred to. shipment_date: type: string format: date-time description: The shipping date for the ASN in ISO 8601 format. shipment_ref: type: string description: Shipment reference of the inventory transaction. purchase_order_number: type: string description: Shipment reference of the inventory transaction. transfer_order_ref: type: string description: Shipment reference of the inventory transaction. transfer_transaction_ref: type: string description: Shipment reference of the inventory transaction. transfer_order_id: type: string description: >- The identifier of the transfer order the ASN was created against. transfer_transaction_id: type: string description: >- The identifier of the transfer transaction the ASN was created against. created_at: type: string format: date-time description: UTC timestamp when the transfer asn was created. chunk_number: type: integer minimum: 1 description: >- The number of current chunk. This can only be a integer number between 1 and total_chunks. total_chunks: type: integer minimum: 1 description: >- Defines the total number of chunks that needs to be processed for a specific transfer transaction. items: type: array description: The list of products from the transfer ASN. items: title: An inventory transaction item description: >- Information that identifies a product that was part of the inventory transaction. type: object required: *ref_44 properties: *ref_45 - title: inventory_transaction.asn_closed description: >- Event regarding the closing of an ASN(advanced shipment notification) on the New Store Omnichannel Cloud. type: object required: &ref_100 - id properties: &ref_101 id: type: string description: Unique identifier of the ASN. - title: inventory_transaction.adjustment_created description: Information about an inventory adjustment. type: object required: &ref_102 - id - fulfillment_node_id - adjustment_type - associate_id - processed_at - chunk_number - total_chunks - items properties: &ref_103 id: type: string description: Unique identifier of the inventory adjustment. fulfillment_node_id: type: string description: >- Identifier of the fulfillment location the adjustment affects. adjustment_type: type: string description: >- The type of the adjustment, e.g., 'Damaged Out', or 'Lost'. This may or may not have a reason associated with it. adjustment_reason: type: string description: >- The reason of the adjustment, e.g., 'Broken', or 'Stained'. origin_stock_location_name: type: string description: >- Stock location name from where the items are moved out, e.g., 'Main', or 'Damaged' destination_stock_location_name: type: string description: >- Stock location name, where items are moved into, e.g., 'Main', or 'Damaged'. note: type: string description: A note about the adjustment. associate_id: type: string description: >- The identifier for the associate who created the adjustment. processed_at: type: string format: date-time description: UTC timestamp when the adjustment was created. chunk_number: type: integer minimum: 1 description: >- The number of current chunk. This can only be a integer number between 1 and total_chunks. total_chunks: type: integer minimum: 1 description: >- Defines the total number of chunks that needs to be processed for a specific transfer transaction. items: type: array description: The list of products from the adjustment. items: title: An inventory transaction item description: >- Information that identifies a product that was part of the inventory transaction. type: object required: *ref_44 properties: *ref_45 - title: inventory_transaction.transfer_order_created description: Information about an inventory transfer order. type: object required: &ref_104 - id - origin_id - destination_id - external_ref - origin_stock_location - created_at - chunk_number - total_chunks - items properties: &ref_105 id: type: string description: Unique identifier of the inventory transfer order. origin_id: type: string description: >- The fulfillment node identifier of the location from where the transfer order is sent. destination_id: type: string description: >- The fulfillment node identifier of the location to where the transfer order is sent. external_ref: type: string description: >- Represents the external reference by which external system can refer to this item. origin_stock_location: type: string description: >- The stock location from which the items are being transferred. created_at: type: string format: date-time description: UTC timestamp when the transfer order was created. chunk_number: type: integer minimum: 1 description: >- The number of current chunk. This can only be a integer number between 1 and total_chunks. total_chunks: type: integer minimum: 1 description: >- Defines the total number of chunks that needs to be processed for a specific transfer transaction. items: type: array description: The list of products from the transfer order. items: title: An inventory transaction item description: >- Information that identifies a product that was part of the inventory transaction. type: object required: *ref_44 properties: *ref_45 - title: inventory_transaction.transfer_order_closed description: Information about an inventory transfer order. type: object required: &ref_106 - id - external_ref properties: &ref_107 id: type: string description: Unique identifier of the inventory transfer order. external_ref: type: string description: >- Represents the external reference by which external system can refer to this item. - title: inventory_count.items_counted description: >- Information about an inventory count(inventory was counted on a location). type: object required: &ref_110 - id - count_type - fulfillment_location_id - associate_id - due_date - started_at - completed_at - chunk_number - total_chunks - items properties: &ref_111 id: type: string description: Unique identifier of the inventory count. count_type: type: string description: >- Type of inventory count (e.g. cycle_count, full_count). fulfillment_location_id: type: string description: >- Identifier of the corresponding fulfillment location. associate_id: type: string description: >- Identifier of the user who completed the inventory count. For cycle counts it is the id of the associate who counted, for the full counts, it is the id of the user who submitted the count. stock_location_name: type: string description: Stock location name. due_date: type: string format: date-time description: >- UTC timestamp of the date the inventory count task is scheduled on. started_at: type: string format: date-time description: >- UTC timestamp when the inventory count task was started. completed_at: type: string format: date-time description: >- UTC timestamp when the inventory count task was completed. chunk_number: type: integer description: >- The number of the current chunk. This can only be an integer number between one and "total_chunks". total_chunks: type: integer description: >- Defines the total number of chunks that need to be processed. external_id: type: string description: >- External identifier of the count task, unique per store. items: type: array description: The list of products from the inventory count. items: title: An inventory count item description: >- Information that identifies a product that was part of a inventory count. type: object required: &ref_108 - product_id - stock_on_hand - count - delta properties: &ref_109 product_id: description: >- The unique identifier of the product that was part of the inventory count. type: string stock_on_hand: description: The stock on hand for the given product. type: integer count: description: The result of the count for the given product. type: integer delta: description: >- The difference between number of products that were counted and the stock on hand. type: integer external_identifiers: type: object description: >- Keys of this object are the names of external identifiers (sku, ean, epc, ...), and values are identifiers themselves. - title: customer.created description: >- `customer.created` contains the newly created customer profile. Note that customer address information is sent in dedicated `customer.address_created` events. type: object required: &ref_112 - id properties: &ref_113 id: type: string description: Unique identifier of the customer. email: type: string description: Main e-mail used by the customer. first_name: type: string description: Customer's first name. last_name: type: string description: Customer's last name. phone: type: string description: Phone number of the customer. source: type: object description: The source of this event properties: &ref_46 location_id: type: string description: >- Fulfillment node ID of the place where the customer profile was created. associate_id: type: string description: >- ID of the associate who created the customer profile. associate_name: type: string description: >- Name of the associate who created the customer profile. associate_email: type: string description: >- Email address of the associate who created the customer profile. created_at: type: string description: UTC timestamp of the customer profile creation. extended_attributes: type: array description: List of all extended attributes for this customer. maxItems: 20 items: type: object required: - name - value maxProperties: 2 properties: name: type: string description: Name of an extended attribute. minLength: 1 value: type: string description: Value of an extended attribute. maxLength: 8192 - title: customer.updated description: >- `customer.updated` contains an updated (previously existing) event. Address updates are sent in the dedicated `customer.address_updated` event. type: object required: &ref_114 - id properties: &ref_115 id: type: string description: Unique identifier of the customer. email: type: string nullable: true description: Main email used by the customer. first_name: type: string nullable: true description: Customer's first name. last_name: type: string nullable: true description: Customer's last name. phone: type: string nullable: true description: Phone number of the customer. source: type: object description: The source of this event properties: *ref_46 updated_at: type: string description: UTC timestamp of the customer profile update. extended_attributes: type: array nullable: true description: List of all extended attributes for this customer. items: type: object required: - name - value maxProperties: 2 properties: name: type: string description: Name of an extended attribute. minLength: 1 value: type: string description: Value of an extended attribute. revision: type: integer description: Revision number of the customer entity. - title: customer.address_created type: object required: &ref_116 - id - customer_id - created_at properties: &ref_117 id: type: string description: Unique identifier of the address. customer_id: type: string description: ID of the customer to whom this address belongs. type: type: string description: Address type, i.e. billing or shipping. enum: - billing - shipping first_name: type: string description: Contact's first name. last_name: type: string description: Contact's last name. company: type: string description: Company part of the address. address_line_1: type: string description: First address line. address_line_2: type: string description: Second address line. address_line1: type: string description: >- First address line. This attribute is deprecated and will be removed in the future. Please use 'address_line_1' instead. address_line2: type: string description: >- Second address line. This attribute is deprecated and will be removed in the future. Please use 'address_line_2' instead. zip_code: type: string description: Postal code. city: type: string description: City name. state: type: string description: State name. country_code: type: string description: ISO 3166-1 alpha-2 country code. contact_phone: type: string description: Phone number for delivery-related communication. created_at: type: string format: date-time description: Creation time of the address. - title: customer.address_updated type: object required: &ref_118 - id - customer_id - customer_revision properties: &ref_119 id: type: string description: Unique identifier of the address. customer_id: type: string description: ID of the customer to whom this address belongs. type: type: string nullable: true description: Address type, i.e. billing or shipping. enum: - billing - shipping first_name: type: string nullable: true description: Contact's first name. last_name: type: string nullable: true description: Contact's last name. company: type: string nullable: true description: Company part of the address. address_line_1: type: string nullable: true description: First address line. address_line_2: type: string nullable: true description: Second address line. address_line1: type: string nullable: true description: >- First address line. This attribute is deprecated and will be removed in the future. Please use 'address_line_1' instead. address_line2: type: string nullable: true description: >- Second address line. This attribute is deprecated and will be removed in the future. Please use 'address_line_2' instead. zip_code: type: string nullable: true description: Postal code. city: type: string nullable: true description: City name. state: type: string nullable: true description: State name. country_code: type: string nullable: true description: ISO 3166-1 alpha-2 country code. contact_phone: type: string nullable: true description: Phone number for delivery-related communication. created_at: type: string nullable: true format: date-time description: Creation time of the address. customer_revision: type: integer description: New customer revision. - title: customer.address_deleted type: object required: &ref_120 - id - customer_id - customer_revision properties: &ref_121 id: type: string description: Identifier of the deleted address. customer_id: type: string description: >- Identifier of the customer that the address was associated to. customer_revision: type: integer description: >- Customer revision at the time when the address was deleted. - title: employee.created description: >- `employee.created` contains the newly created employee profile. type: object required: &ref_122 - id - email - first_name - last_name - is_active - created_at properties: &ref_123 id: type: string maxLength: 36 description: The identifier of the employee email: maxLength: 256 type: string description: E-mail address of the employee first_name: maxLength: 256 type: string description: First name of the employee last_name: maxLength: 256 type: string description: Last name of the employee phone: maxLength: 32 type: string description: Telephone number of the employee store_id: minLength: 1 maxLength: 256 type: string description: The identifier of the store the employee is located. is_active: type: boolean description: Indicator if the employee is active or not created_at: type: string format: date-time description: UTC timestamp when the employee was created revision: type: number description: >- Revision number of the employee record, starts with 1 and increments with every update. - title: employee.updated description: >- `employee.updated` contains an updated (previously existing) employee event. type: object required: &ref_124 - id - email - first_name - last_name - is_active - created_at - updated_at properties: &ref_125 id: type: string maxLength: 36 description: The identifier of the employee email: maxLength: 256 type: string description: E-mail address of the employee first_name: maxLength: 256 type: string description: First name of the employee last_name: maxLength: 256 type: string description: Last name of the employee phone: maxLength: 32 type: string description: Telephone number of the employee store_id: minLength: 1 maxLength: 256 type: string description: The identifier of the store the employee is located. is_active: type: boolean description: Indicator if the employee is active or not created_at: type: string format: date-time description: UTC timestamp when the employee was created updated_at: type: string format: date-time description: UTC timestamp when the employee was updated revision: type: number description: >- Revision number of the employee record, starts with 1 and increments with every update. - title: cash_drawer.transaction_completed description: >- `cash_drawer.transaction_completed` is emitted when a draft cash transaction is marked as completed type: object required: &ref_126 - id - cash_drawer_id - created_at - amount_balance properties: &ref_127 id: type: string description: Unique identifier of the transaction. store_id: type: string description: Unique identifier of the store. cash_drawer_id: type: string description: Unique identifier of the cash drawer. cash_drawer_external_id: type: string description: External identifier of the cash drawer. associate_id: type: string description: >- Identifier of the associate who performed the action. created_at: type: string format: date-time description: >- UTC timestamp of the time when the action was performed. correlation_id: type: string description: >- Identifies the operation that triggered this transaction. The value of this field can be the ID of several entities. order_id: type: string description: >- Identifier of the order which transaction was part of. transaction_kind: enum: - reconciliation - sale - end_of_day_withdrawal - float_adjustment - non_sale description: The transaction kind. transaction_type: enum: - add_to_float - add_petty_cash - transfer_in - adjustment_in - remove_petty_cash - cash_pull - transfer_out - adjustment_out - no_sale - gift_card_cash_out description: >- The transaction type of the non-sale transaction. Will only contain value for non_sale transaction kind. reason_code: type: string description: >- The reason code of the non-sale transaction. Will only contain value for non_sale transaction kind. amount_balance: description: >- The amount that was cashed in or out, can be negative when money is taken out of the cash drawer. type: object required: &ref_47 - value - currency properties: &ref_48 value: type: number description: The value of the amount in decimals. currency: type: string minLength: 3 description: >- The currency of the amount, using ISO-4217 Currency Code. - title: cash_drawer.drawer_created description: >- `cash_drawer.drawer_created` is emitted when a new cash drawer is created. type: object required: &ref_128 - id - created_at properties: &ref_129 id: type: string description: Unique identifier of the cash drawer. store_id: type: string description: Unique identifier of the store. cash_drawer_external_id: type: string description: External identifier of the cash drawer. associate_id: type: string description: >- Identifier of the associate who performed the action. created_at: type: string format: date-time description: >- UTC timestamp of the time when the drawer was created. - title: cash_drawer.drawer_updated description: >- `cash_drawer.drawer_updated` is emitted when an existing cash drawer is updated. type: object required: &ref_130 - id - decomissioned - revision properties: &ref_131 id: type: string description: Unique identifier of the cash drawer. store_id: type: string description: Unique identifier of the store. cash_drawer_external_id: type: string description: External identifier of the cash drawer. associate_id: type: string description: >- Identifier of the associate who performed the action. updated_at: type: string format: date-time description: >- UTC timestamp of the time when the drawer was updated. decomissioned: type: boolean description: Whether the cash drawer has been decomissioned. revision: type: integer description: >- The revision number of the cash drawer's current state. - title: cash_drawer.count_submitted description: >- `cash_drawer.count_submitted` is emitted when an associate performs cash count. type: object required: &ref_132 - id - cash_drawer_id - created_at - reason - counted_balance properties: &ref_133 id: type: string description: Unique identifier of the cash count event. store_id: type: string description: Unique identifier of the store. cash_drawer_id: type: string description: Unique identifier of the cash drawer. cash_drawer_external_id: type: string description: External identifier of the cash drawer. associate_id: type: string description: >- Identifier of the associate who performed the action. created_at: type: string format: date-time description: >- UTC timestamp of the time when the action was performed. correlation_id: type: string description: >- Identifies the operation that triggered this transaction. The value of this field can be the ID of several entities. reason: enum: - intra_day_balance - end_of_day_balance description: >- The reason why the associate performed the cash count. Can be either `intra_day_balance` or `end_of_day_balance` counted_balance: description: The amount that was counted by the associate. type: object required: *ref_47 properties: *ref_48 - title: cash_drawer.float_defined description: >- `cash_drawer.float_defined` is emitted when float was defined/adjusted in the cash drawer. type: object required: &ref_134 - id - cash_drawer_id - created_at - float_balance properties: &ref_135 id: type: string description: >- Unique identifier of the drawer activation from which the amount was defined. store_id: type: string description: Unique identifier of the store. cash_drawer_id: type: string description: Unique identifier of the cash drawer. cash_drawer_external_id: type: string description: External identifier of the cash drawer. associate_id: type: string description: >- Identifier of the associate who performed the action. created_at: type: string format: date-time description: >- UTC timestamp of the time when the action was performed. correlation_id: type: string description: >- Identifies the operation that triggered this transaction. The value of this field can be the ID of several entities. float_balance: description: >- The amount that was cashed in during the cash drawer activation. type: object required: *ref_47 properties: *ref_48 - title: cash_drawer.activity_recorded description: >- `cash_drawer.activity_recorded` is emitted when a new activity is recorded for a cash drawer. In practice only activation and deactivation. type: object required: &ref_136 - id - cash_drawer_id - created_at - activity properties: &ref_137 id: type: string description: Unique identifier of the activity event. store_id: type: string description: Unique identifier of the store. cash_drawer_id: type: string description: Unique identifier of the cash drawer. cash_drawer_external_id: type: string description: External identifier of the cash drawer. associate_id: type: string description: >- Identifier of the associate who performed the action. created_at: type: string format: date-time description: >- UTC timestamp of the time when the action was performed. correlation_id: type: string description: >- Identifies the operation that triggered this transaction. The value of this field can be the ID of several entities. activity: enum: - activation - deactivation description: >- The action performed on the cash drawer. Either 'activation' or 'deactivation' - title: gift_card.deactivated description: >- `gift_card.deactivated` is emitted when an active gift card has been deactivated type: object required: &ref_138 - id - deactivated_at - store_id properties: &ref_139 id: type: string description: >- Unique identifier of the gift card - gift card number. deactivated_at: type: string description: Timestamp when the card has been deactivated. store_id: type: string description: >- Unique identifier of the store where the card has been deactivated. - title: clienteling.optin_changed description: >- `clienteling.optin_changed` is sent whenever the opt-in state for a customer changes, such as opting in our out of a conversation, when a new conversation is started, when a conversation is removed or when the customer's phone number is changed type: object properties: &ref_140 customer_id: type: string description: ID of the customer. phone_number: type: string description: Phone number of the customer. opted_out: type: boolean description: Whether the customer has opted out from clienteling. opted_out_at: type: string nullable: true format: date-time description: >- If the customer customer has opted out from clienteling, the date and time that they opted out. opted_in: type: object description: >- A map from store ID to opt-in state for this customer. additionalProperties: type: object properties: opt_in_state: type: string description: >- The opt-in state between this store and customer. enum: - waiting - accepted - rejected opt_in_state_modified_at: type: string description: >- The date and time the opt-in state was last modified. format: date-time required: - opt_in_state - opt_in_state_modified_at required: &ref_141 - customer_id - phone_number - opted_out - opted_in - title: reservation.created description: >- `reservation.created` contains the newly created reservation. type: object required: &ref_142 - id - external_id - created_at - expires_at - associate_id - customer_profile_id - location_id - items - status properties: &ref_143 id: type: string description: Unique identifier for the reservation. external_id: type: string description: >- Short, human-readable identifier for the reservation. created_at: type: string format: date-time description: Date and time the reservation was created. expires_at: type: string format: date-time description: Date and time the reservation expires. associate_id: type: string nullable: true description: >- ID of the associate that created the reservation. Null if the reservation was created via an API client. customer_profile_id: type: string description: Profile ID of the customer the reservation is for. location_id: type: string description: >- ID of the fulfillment location the reservation is for. items: type: array description: Items associated with the reservation. items: type: object required: - id - product_id - status properties: id: type: string description: Unique identifier for the reservation item. product_id: type: string description: >- ID of the product the reservation item corresponds to. status: type: string description: Reservation item status. status: type: string description: Reservation status. - title: reservation.updated description: >- `reservation.updated` contains changes when reservation is updated. type: object required: &ref_144 - id - updated_at - items - idempotency_key - status properties: &ref_145 id: type: string description: Unique identifier for the reservation. updated_at: type: string format: date-time description: Date and time the reservation was updated. items: type: array description: Items associated with the reservation. items: type: object required: - id - product_id - status - updated_at properties: id: type: string description: Unique identifier for the reservation item. product_id: type: string description: >- ID of the product the reservation item corresponds to. status: type: string description: Reservation item status. updated_at: type: string format: date-time description: >- Date and time the status of the item was updated. idempotency_key: type: string description: Unique identifier for the reservation updated. status: type: string description: Reservation status. required: true components: schemas: public_event: title: Public event description: >- The public event hold information about the tenant, a name to identify the event, a timestamp as well as the provided payload. type: object required: *ref_49 properties: *ref_50 exchanges: type: array description: Array of exchange related information. maxItems: 100 items: *ref_51 discount: type: object description: A discount coupon applied to the order. required: *ref_52 properties: *ref_53 address: type: object required: *ref_0 properties: *ref_1 extended_attributes: type: array description: A set of custom attributes defined during the order creation. maxItems: 100 items: *ref_2 tax_provider_details: type: array description: List of detailed tax information. maxItems: 100 required: *ref_34 items: *ref_35 discount_details: type: object description: A discount applied to an item. required: *ref_54 properties: *ref_55 external_identifiers: type: object description: >- Keys of this object are the names of external identifiers (sku, ean, epc, ...), and values are identifiers themselves. maxProperties: 105 properties: *ref_36 additionalProperties: *ref_37 order_created: title: order.created description: >- `order.created` is sent directly after order placement. It contains all order and order item details. type: object required: *ref_3 properties: *ref_56 order_opened: title: order.opened description: >- `order.opened` is sent after the grace period. It contains all order and order item details. Any order changes during grace period will be reflected in the event payload. type: object required: *ref_3 properties: *ref_57 order_completed: title: order.completed description: >- `order.completed` is sent when all order items are fulfilled (or cancelled). Note that payment processing might not be complete yet. type: object required: *ref_58 properties: *ref_59 order_cancelled: title: order.cancelled description: '`order.cancelled` is sent when the whole order is cancelled.' type: object required: *ref_60 properties: *ref_61 order_items_cancelled: title: order.items_cancelled description: >- `order.items_cancelled` is sent whenever one or more order items are cancelled. type: object required: *ref_62 properties: *ref_63 order_items_on_hold: title: order.items_on_hold description: >- `order.items_on_hold` is sent whenever one or more order items have been put on hold, because their fulfillment could not proceed. type: object required: *ref_64 properties: *ref_65 order_serial_numbers_added: title: order.serial_numbers_added description: >- `order.serial_numbers_added` is sent whenever one or more items in an order have a serial number assigned. type: object required: *ref_66 properties: *ref_67 order_customer_profile_amended: title: order.customer_profile_amended description: >- `order.customer_profile_amended` is sent whenever a customer profile has been amended to an order. type: object required: *ref_68 properties: *ref_69 order_items_swapped: title: order.items_swapped description: >- `order.items_swapped` is sent when one order items is swapped against another product. Prices are not affected by an item swap type: object required: *ref_70 properties: *ref_71 invoice_created: title: invoice.created type: object required: *ref_72 properties: *ref_73 return_processed: title: return.processed description: >- `return.processed` is sent when one or more items have been returned. Processing of the associated refund transaction might not be completed yet. type: object required: *ref_74 properties: *ref_75 fulfillment_request_assigned: title: fulfillment_request.assigned description: >- `fulfillment_request.assigned` is sent when a fulfillment request for one or more items has been dispatched to a fulfillment location. type: object required: *ref_76 properties: *ref_77 fulfillment_request_items_completed: title: fulfillment_request.items_completed description: >- `fulfillment_request.items_completed` is sent when one or more items have been fulfilled, i.e., shipped or handed over to the customer. type: object required: *ref_78 properties: *ref_79 fulfillment_request_items_failed: title: fulfillment_request.items_failed description: >- `fulfillment_request.items_failed` is sent when one or more items could not be fulfilled at the designated fulillment location. It includes the reason why the items could not be fulfilled. type: object required: *ref_80 properties: *ref_81 fulfillment_request_items_ready_for_handover: title: fulfillment_request.items_ready_for_handover description: >- `fulfillment_request.items_ready_for_handover` have been packed and are ready for handover to the customer or the shipping provider type: object required: *ref_82 properties: *ref_83 refund_request.issued: title: refund_request.issued description: >- `refund_request.issued` is sent when a customer has been given an appeasement refund. It contains the reason and other details of the refund request. Processing of the refund transaction associated with this appeasement might not be completed yet. This event is not about financial refund transactions. They are covered in `payment_account.amount_refunded` type: object required: *ref_84 properties: *ref_85 transaction: title: Payment Account transaction. type: object required: *ref_86 properties: *ref_87 instrument: title: Payment Account instrument. description: >- A payment account instrument is a representation of a payment method for a specific psp. type: object required: *ref_88 properties: *ref_89 payment_account_amount_authorized: title: payment_account.amount_authorized description: >- `payment_account.amount_authorized` is sent when one or more authorized transactions have been processed successfully. type: object required: *ref_38 properties: *ref_90 payment_account_amount_captured: title: payment_account.amount_captured description: >- `payment_account.amount_captured` is sent when one or more capture transactions have been processed successfully. type: object required: *ref_38 properties: *ref_91 payment_account_amount_refunded: title: payment_account.amount_refunded description: >- `payment_account.amount_refunded` is sent when one or more refund transactions have been processed successfully. type: object required: *ref_38 properties: *ref_92 payment_account_amount_voided: title: payment_account.amount_voided description: >- `payment_account.amount_voided` is sent when one or more authorized transactions have been voided. type: object required: *ref_38 properties: *ref_93 transaction_item: title: An inventory transaction item description: >- Information that identifies a product that was part of the inventory transaction. type: object required: *ref_44 properties: *ref_45 inventory_transaction_items_received: title: inventory_transaction.items_received description: >- Information about an inventory transaction (inventory was moved to a location). type: object required: *ref_94 properties: *ref_95 inventory_transaction_items_ready_for_handover: title: inventory_transaction.items_ready_for_handover description: >- Information about an inventory transfer (items ready to be moved from a location). type: object required: *ref_96 properties: *ref_97 inventory_transaction_asn_created: title: inventory_transaction.asn_created description: >- Information about an inventory transfer ASN(advanced shipment notification). type: object required: *ref_98 properties: *ref_99 inventory_transaction_asn_closed: title: inventory_transaction.asn_closed description: >- Event regarding the closing of an ASN(advanced shipment notification) on the New Store Omnichannel Cloud. type: object required: *ref_100 properties: *ref_101 inventory_transaction_adjustment_created: title: inventory_transaction.adjustment_created description: Information about an inventory adjustment. type: object required: *ref_102 properties: *ref_103 inventory_transaction_transfer_order_created: title: inventory_transaction.transfer_order_created description: Information about an inventory transfer order. type: object required: *ref_104 properties: *ref_105 inventory_transaction_transfer_order_closed: title: inventory_transaction.transfer_order_closed description: Information about an inventory transfer order. type: object required: *ref_106 properties: *ref_107 inventory_count_item: title: An inventory count item description: >- Information that identifies a product that was part of a inventory count. type: object required: *ref_108 properties: *ref_109 inventory_count_items_counted: title: inventory_count.items_counted description: >- Information about an inventory count(inventory was counted on a location). type: object required: *ref_110 properties: *ref_111 source: type: object description: The source of this event properties: *ref_46 customer_created: title: customer.created description: >- `customer.created` contains the newly created customer profile. Note that customer address information is sent in dedicated `customer.address_created` events. type: object required: *ref_112 properties: *ref_113 customer_updated: title: customer.updated description: >- `customer.updated` contains an updated (previously existing) event. Address updates are sent in the dedicated `customer.address_updated` event. type: object required: *ref_114 properties: *ref_115 customer_address_created: title: customer.address_created type: object required: *ref_116 properties: *ref_117 customer_address_updated: title: customer.address_updated type: object required: *ref_118 properties: *ref_119 customer_address_deleted: title: customer.address_deleted type: object required: *ref_120 properties: *ref_121 employee_created: title: employee.created description: '`employee.created` contains the newly created employee profile.' type: object required: *ref_122 properties: *ref_123 employee_updated: title: employee.updated description: >- `employee.updated` contains an updated (previously existing) employee event. type: object required: *ref_124 properties: *ref_125 amount: type: object required: *ref_47 properties: *ref_48 transaction_completed: title: cash_drawer.transaction_completed description: >- `cash_drawer.transaction_completed` is emitted when a draft cash transaction is marked as completed type: object required: *ref_126 properties: *ref_127 drawer_created: title: cash_drawer.drawer_created description: >- `cash_drawer.drawer_created` is emitted when a new cash drawer is created. type: object required: *ref_128 properties: *ref_129 drawer_updated: title: cash_drawer.drawer_updated description: >- `cash_drawer.drawer_updated` is emitted when an existing cash drawer is updated. type: object required: *ref_130 properties: *ref_131 count_submitted: title: cash_drawer.count_submitted description: >- `cash_drawer.count_submitted` is emitted when an associate performs cash count. type: object required: *ref_132 properties: *ref_133 float_defined: title: cash_drawer.float_defined description: >- `cash_drawer.float_defined` is emitted when float was defined/adjusted in the cash drawer. type: object required: *ref_134 properties: *ref_135 activity_recorded: title: cash_drawer.activity_recorded description: >- `cash_drawer.activity_recorded` is emitted when a new activity is recorded for a cash drawer. In practice only activation and deactivation. type: object required: *ref_136 properties: *ref_137 deactivated: title: gift_card.deactivated description: >- `gift_card.deactivated` is emitted when an active gift card has been deactivated type: object required: *ref_138 properties: *ref_139 optin_changed: title: clienteling.optin_changed description: >- `clienteling.optin_changed` is sent whenever the opt-in state for a customer changes, such as opting in our out of a conversation, when a new conversation is started, when a conversation is removed or when the customer's phone number is changed type: object properties: *ref_140 required: *ref_141 reservation_created: title: reservation.created description: '`reservation.created` contains the newly created reservation.' type: object required: *ref_142 properties: *ref_143 reservation_updated: title: reservation.updated description: '`reservation.updated` contains changes when reservation is updated.' type: object required: *ref_144 properties: *ref_145 securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: string