Customer Invoice

The Customer Invoice API generates and fetches a customer invoice in .pdf format for a specified order. This invoice is available in both A4 and A6 sizes, suitable for printing, shipments, and record-keeping purposes.

Request Type: POST
Scheme: HTTPS
Endpoint: https://{{host}}/oms/v3/shipment/invoice

Try out Fynd Konnect's Customer Invoice Endpoint

Common Request Header

Header	Mandatory	Description
`x-access-token`	Yes	The token required for authenticated calls to Fynd Konnect.

Important Considerations

Support customer invoice fetch for upto 20 orders in a single call

Body

orderIdstringrequired

Unique identifier for the order for which the invoice needs to be fetched from Fynd

Success Response

payloadCountinteger

Number of payloads in the request

successCountinteger

Number of successfully processed payloads

failedCountinteger

Number of payloads that failed

statusstring

Status of the API call

errorsArray of objects

Empty if everything succeeded

API Call Example

curl -i -X POST \
  https://fyndkonnect.konnect.uat.fyndx1.de/oms/v3/shipment/invoice \
  -H 'Content-Type: application/json' \
  -H 'x-access-token: YOUR_API_KEY_HERE' \
  -d '[
    {
      "orderId": "string"
    }
  ]'

Response

application/pdf

As a response, the customer invoice PDF will be the output.

Error Codes

Reason	Code	Description
Invalid `orderId`	IN400	If `orderId` does not belong to the requested location
Invalid request	IN403	If invoice request is raised before the order is packed

Next Steps

Pre-dispatch, the shipping label can be fetched using Shipping Label endpoint
Once an order has been dispatched from the warehouse, a dispatch call needs to be made to Fynd; see Order Dispatch