Library OpenApi Overview About these APIs Architecture Authentication Error Responses Locating a Server Sessions Design Guides Guides and Hints Examples Pricing for Websites Accepting Vouchers PreAuth Payment Replication Common Apis The most used APIs Create New Sale Payment Completion Multiple Locations Delivery Addresses Create New Sale v2 Customers Locations Products Staff WebHooks eCommerce Apis These APIs are often used with eCommerce website integrations Get Pricing Card Inquiry Report & Analysis Grouped or analysed report data. Typically used to build reports and dashboards Today Login Access Pinboard ReportRequest Advanced Information More indepth information Caller Handling HTTP Protocol Bulk Data Downloads Document Uploading RetailConfig Under Development Details of APIs that will be available shortly. Documentation provided is for early adopters Get Receipt

Delivery Addresses on Create New Sale API

Ship To Customer

{
    "ExternalId": "Sale.000001",
    "Location": "Website",
    "CompletedDt": "2019-07-01T10:35",
    "Phase": 200,
    "LINE": ...,
    "Delivery": {
        "Instructions": "Leave beside BBQ if nobody home",
        "Address": "1a My street|Douglas|Taranaki",
        "Email": "sue@example.com"
    }
}

Click and Collect

{
    "ExternalId": "Sale.000001",
    "Location": "Website",
    "CompletedDt": "2019-07-01T10:35",
    "Phase": 200,
    "LINE": ...,
    "Delivery": {
        "CollectLocation": "York"
    }
}

Timeslots and Other Allocations

The following information can be supplied as part of the delivery information.

DeliverDt
The date the delivery is expected
DeliverTime
Free form text (20 characters) describing the requested delivery time
DeliverDuration
The time in minutes that any DeliverTime is considred valid. For example a DeliverTime=3pm and DeliverDuration=120 means that the delivery should occur between 3 and 5pm. DeliverDuration is not commonly used.

Known Customer Addresses

If the retailer is using Customer Contact Cards (multiple contacts/addresses for a single customer), then you can specify the delivery address by supplying the Contact ID

{
    "ExternalId": "Sale.000001",
    "Location": "Website",
    "CompletedDt": "2019-07-01T10:35",
    "Phase": 200,
    "LINE": ...,
    "Delivery": {
        "PhyskeyContact": "ABCHJDU28947GHS34NJOPQ"
    }
}