API Reference
Fulfilment
Retrieve a fulfilment for an account
2min
GET
AUTHENTICATION
Authorization
Bearer
Bearer
PATH PARAMETERS
accountReference
string
*Reference for the account to return fulfilments for
fulfilmentReference
string
*Reference for the fulfilment to return
HEADER PARAMETERS
X-TokenId
string
The eSuite Token Id
X-SessionId
string
The eSuite Session Id
X-Version
string
*The eSuite Version
Origin
string
The eSuite Origin
RESPONSES
200
Ok
FictiveGlobal.Api.Rest.Dtos.v2.Fulfilment
The dto to transfer Fulfilment data
fulfilmentReference
string
The Fulfilment reference
dateCreated
string<date-time>
Example: 2021-09-21T05:33:17.9791453
The Fulfilment date created
dateLastUpdated
string<date-time>
Example: 2021-09-21T05:33:17.9791453
The Fulfilment last updated
cartReference
string
The Fulfilment reference
fulfilmentDate
string<date-time>
Example: 2021-09-21T05:33:17.9791453
The issuing fulfilment date
supplierNotificationDate
string<date-time>
Example: 2021-09-21T05:33:17.9791453
The Supplier Notification date
expectedDeliveryDate
string<date-time>
Example: 2021-09-21T05:33:17.9791453
The Expected delivery date
status
string<Pending | Processing | Completed | Dispatched | Cancelled>
The fulfilment Status
type
string<Physical | Digital>
The Fulfilment Type
subscriptionReference
string
SubscriptionReference
paymentInstructionReference
string
PaymentInstructionReference
addressReference
string
AddressReference
paymentReference
string
PaymentReference
fulfilmentItems
FictiveGlobal.Api.Rest.Dtos.v1.FulfilmentLineItem[]
FulfilmentItems
customFulfilmentParameters
object
Example: [object Object]
A key-value store to hold custom params for the fulfilment
401
β’ API Authentication Failure: Invalid Authentication Type/Credentials Provided
404
β’ Account cannot be found
<br /> β’ fulfilment cannot be found
ο»Ώ
ο»Ώ
Updated 22 Sep 2023
Did this page help you?