Batch

Get Batch by ID

Get batch details from ID

get/api/Batch/{id}

Request

  • Base URL: https://api.mintsoft.co.uk
  • URL: https://api.mintsoft.co.uk/api/Batch/{id}
  • Auth: API key in header ms-apikey

Path parameters

idinteger required

Batch ID

Query parameters

includeOrderItemsboolean

Include Order Items for each Order

Response

OK

ClientIdinteger required
CLIENT_CODEstring
OrderNumberstring required
ExternalOrderReferencestring
OrderDatestring date-time
DespatchDatestring date-time
AtNewDatestring date-time
SLAWarningDatestring date-time
SLADespatchDatestring date-time
RequiredDespatchDatestring date-time
RequiredDeliveryDatestring date-time
Titlestring
FirstNamestring required
LastNamestring
CompanyNamestring
Address1string required
Address2string
Address3string
Townstring
Countystring
PostCodestring required
Phonestring
Mobilestring
Emailstring
CountryIdinteger required
Sourcestring
Commentsstring
GiftMessagesstring
DeliveryNotesstring
VATNumberstring
EORINumberstring
UKIMSNumberstring
RFCNumberstring
PIDNumberstring
OrderStatusIdinteger
NumberOfParcelsinteger
TotalItemsinteger
TotalWeightnumber double
OrderValuenumber double
Partinteger
NumberOfPartsinteger
CourierServiceTypeIdinteger required
CourierServiceIdinteger
CourierServiceNamestring
TrackingNumberstring
TrackingURLstring
ShippingTotalExVatnumber double
ShippingTotalVatnumber double
DiscountTotalExVatnumber double
DiscountTotalVatnumber double
TotalVatnumber double
PIIRemovedboolean
ShippingNetnumber double
ShippingTaxnumber double
ShippingGrossnumber double
DiscountNetnumber double
DiscountTaxnumber double
TotalOrderNetnumber double
TotalOrderTaxnumber double
TotalOrderGrossnumber double
DiscountGrossnumber double
WarehouseIdinteger
WAREHOUSE_CODEstring
ChannelIdinteger
CurrencyIdinteger
DespatchedByUserstring
OrderLockboolean
Tagsstring
SourceOrderDatestring date-time
IDinteger
LastUpdatedstring date-time
LastUpdatedByUserstring

Changes

No recorded changes to this operation across all 1 revision of this API.