Jetti API documentation

PUT /goods-receipts/{id}.json

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

application/json

Body Required

adminNotes string | null

Admin notes
aftershipId string | null

Aftership
commercialInvoiceUrl string | null

Commercial invoice url
createdAt string(date-time)

Created at
days integer(int32) | null

Days
durationTerms string | null

Duration terms
files object | null | array | boolean | integer | number | string

Any of:
object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null

Files

Files

Files

Files

Files

Files
grams number | null Required

Grams

Default value is 0.
id integer(int32)

Id
intercomMessageId string | null

Intercom message
inventoryStatus string Required

Inventory status

Values are received or packedAway. Default value is received.
labelError string | null

Label error
labelFileFormat string | null

Label file format

Values are png or pdf.
labelFiles object | null | array | boolean | integer | number | string

Any of:
object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null

Label files

Label files

Label files

Label files

Label files

Label files
labelRefund boolean | null Required

Label refund

Default value is false.
labelUrl string | null

Label url
muteError boolean | null Required

Mute error

Default value is false.
price number | null Required

Price

Default value is 0.
provider string | null

Provider
purchaseId integer(int32) Required

Purchase
quoteId string | null

Quote
reference string Required

Reference
serviceLevel string | null

Service level
serviceLevelTerms string | null

Service level terms
shippoLabelIds array[string] | null

Shippo label ids
tags array[string] | null

Tags
trackingCompany string | null

Tracking company
trackingNumber string | null

Tracking number
trackingStatus string | null

Tracking status

Values are delivered, failure, pre_transit, returned, transit, or unknown.
trackingStatusDate string(date-time) | null

Tracking status date
trackingStatusDetails string | null

Tracking status details
trackingUrl string | null

Tracking url
updatedAt string(date-time)

Updated at
userId integer(int32) | null

User
xeroId string | null

Xero

PUT /goods-receipts/{id}.json

curl \
 -X PUT http://api.example.com/v1/goods-receipts/{id}.json \
 -H "Content-Type: application/json" \
 -d '{"adminNotes":"string","aftershipId":"string","commercialInvoiceUrl":"string","createdAt":"2023-05-04T09:42:00+00:00","days":42,"durationTerms":"string","files":{},"grams":0,"id":42,"intercomMessageId":"string","inventoryStatus":"received","labelError":"string","labelFileFormat":"png","labelFiles":{},"labelRefund":false,"labelUrl":"string","muteError":false,"price":0,"provider":"string","purchaseId":42,"quoteId":"string","reference":"string","serviceLevel":"string","serviceLevelTerms":"string","shippoLabelIds":["string"],"tags":["string"],"trackingCompany":"string","trackingNumber":"string","trackingStatus":"delivered","trackingStatusDate":"2023-05-04T09:42:00+00:00","trackingStatusDetails":"string","trackingUrl":"string","updatedAt":"2023-05-04T09:42:00+00:00","userId":42,"xeroId":"string"}'

Request example

{
  "adminNotes": "string",
  "aftershipId": "string",
  "commercialInvoiceUrl": "string",
  "createdAt": "2023-05-04T09:42:00+00:00",
  "days": 42,
  "durationTerms": "string",
  "files": {},
  "grams": 0,
  "id": 42,
  "intercomMessageId": "string",
  "inventoryStatus": "received",
  "labelError": "string",
  "labelFileFormat": "png",
  "labelFiles": {},
  "labelRefund": false,
  "labelUrl": "string",
  "muteError": false,
  "price": 0,
  "provider": "string",
  "purchaseId": 42,
  "quoteId": "string",
  "reference": "string",
  "serviceLevel": "string",
  "serviceLevelTerms": "string",
  "shippoLabelIds": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "trackingCompany": "string",
  "trackingNumber": "string",
  "trackingStatus": "delivered",
  "trackingStatusDate": "2023-05-04T09:42:00+00:00",
  "trackingStatusDetails": "string",
  "trackingUrl": "string",
  "updatedAt": "2023-05-04T09:42:00+00:00",
  "userId": 42,
  "xeroId": "string"
}