Update Invoice

put https://sandbox.api.deliverysolutions.co/api/v2/returns/invoice/{invoiceId}

Path Params

invoiceId

string

required

Invoice Id (_id) created during the Create Invoice API

Body Params

itemList

array of objects

Array of Items which contains all the information about images , SKU & dimensions etc.

itemList

groupId

string

E-commerce order id should be mapped to groupId field so that tracking and returns can be utilise efficiently.

orderExternalId

string

Order Id by which retailer can refer the Invoice's order.

customer

object

Customer information associated with the invoice

orderInfo

object

required

Subset of the Order Object from the DS , If retailer is dispatching using Delivery Solutions

deliveryAddress

object

Customer delivery address at which Order being return was delivered or Customer address from which returns might get picked up

brandExternalId

string

required

Brand External Id for which the Invoice is being created.

createdDate

int64

required

The date at which the original order was created

timeZone

string

required

The timezone in which the original order was created

storeExternalId

string

Store External Id from where the Order was dispatched.

Responses

Language

Credentials


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://sandbox.api.deliverysolutions.co/api/v2/returns/invoice/invoiceId \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --header 'tenantId: YOUR_TENANT_ID' \
6
     --header 'x-api-key: YOUR_API_KEY' \
7
     --header 'x-compression: true'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400