The Invoice Managment API empowers retailers to generate invoices for e-commerce orders dispatched outside the API platform. It captures essential data such as customer information, delivery addresses, and order details to enable seamless tracking and efficient returns processing. By utilizing this API, retailers can enhance operational efficiency and improve the customer experience.

• Intelligent Invoice Grouping: - Streamline returns management by leveraging the groupId field in the Order Model to intelligently group multiple invoices associated with a single e-commerce order. This feature simplifies the processing of complex orders and improves organizational workflows.

• Flexible Invoice Management: - Modify invoices effortlessly using the Update Invoice API, enabling seamless updates when item details are unavailable during the initial Create Invoice call.

• Efficient Product Returns: - Facilitate a seamless and customer-friendly returns process with real-time tracking and updates. The platform ensures accurate handling of return requests, reducing processing time and enhancing overall customer satisfaction.

Once set up as a user, you can leverage the Invoice Management API to ingest order information for e-commerce orders dispatched outside the API platform. By integrating this functionality, you can intelligently group multiple invoices for streamlined returns management and seamlessly update invoices as new details become available. This ensures accurate tracking and efficient processing.

• What information is required to create an invoice?

  • groupId: The e-commerce order ID mapped to the invoice for efficient tracking and returns management.
  • orderExternalId: The retailer-specific order reference.
  • customer object: Includes customer information.
  • orderInfo object: Subset of the order data, including deliveryAddress.
  • brandExternalId: Identifies the brand associated with the invoice.
  • createdDate: The date the original order was created (in int64 format).
  • timeZone: Timezone of the order creation date."
  • storeExternalId: The ID of the store from which the order was dispatched.

• When should I use the Update Invoice API?

  The Update Invoice API is used to modify an existing invoice when new details, such as item specifics, become available or corrections are needed. For example, you can update the itemList to include SKU details, dimensions, or images after the initial invoice creation.

• What is the role of the customer object in the API?

  The customer object provides critical customer details, including delivery address and order information. This data ensures that invoices are correctly associated with the right customer and facilitates efficient returns management.

• Can I update the delivery address for an existing invoice?

  Yes, the Update Invoice API allows you to modify the deliveryAddress object if changes to the customer's address or return location are required.

• Does the API support batch updates for invoices?

  Currently, the API supports updating invoices individually using the Update Invoice API. For batch updates, separate calls for each invoice are required.

When the system is unable to respond to a request, be it from a malformed request, an illegal or invalid value, or other issues, the API generates an error response.

Successful response may or may not include warnings.

1. Without warnings - Indicates the request has been processed as anticipated.
2. With warnings - Indicates the request has been processed with potentially unanticipated results. The warning contains information in the response that should be passed to the end user.

The severity of an error may be transient or hard.

• Transient error - Indicates an error that is temporary in nature. Such errors may be caused by response timeouts due to high server loads or scheduled maintenance in progress. The request may be issued successfully at a later time.
• Hard error - Indicates the request has a problem that the system is not able to resolve. These errors are critical and prevent requests from processing.

POST

/invoices/{invoice_id}

PUT