ship.adoc

Simple Hospitality Interchange Protocol

Table of Contents

• 1. Sample messages
  • 1.1. Sample guest-stay messages
    • 1.1.1. Guest-stay message with commonly used fields
    • 1.1.2. Guest-stay message with all possible fields
  • 1.2. Sample guest-stay list messages
    • 1.2.1. Guest-stay list message with multiple guest-stays
  • 1.3. Sample profile messages
    • 1.3.1. Profile message with commonly used fields
    • 1.3.2. Profile message with all possible fields
  • 1.4. Sample simple guest-stay messages
    • 1.4.1. Simple guest-stay message with commonly used fields
    • 1.4.2. Simple guest-stay message with all possible fields
  • 1.5. Sample simple guest-stay list messages
    • 1.5.1. Simple guest-stay list message with multiple simple guest-stays
  • 1.6. Sample guest-stay list result messages
    • 1.6.1. Guest-stay list result message with success result
    • 1.6.2. Guest-stay list result message with status, errors, and warnings only
    • 1.6.3. Guest-stay list result message with all possible fields
  • 1.7. Sample profile list result messages
    • 1.7.1. Profile list result message with success result
    • 1.7.2. Profile list result message with all possible fields

The Simple Hospitality Interchange Protocol, or SHIP, is a JSON-based message format, combined with a simple HTTP-based API, that aims to make it easy for hospitality-related systems and applications to exchange messages. This document contains specifications of the JSON messages, as well as a number of sample messages. For details on the HTTP-based API, please contact your SHIP integration partner.

ship-messages.adoc

guest-stay.adoc

guest-stay-list.adoc

profile.adoc

simple-guest-stay.adoc

simple-guest-stay-list.adoc

common-objects.adoc

result.adoc

guest-stay-result.adoc

guest-stay-list-result.adoc

profile-result.adoc

profile-list-result.adoc

1. Sample messages

1.1. Sample guest-stay messages

1.1.1. Guest-stay message with commonly used fields

Listing 1. Guest-stay message with commonly used fields

link:../samples/guest-stays/guest-stay-typical.json[role=include]

1.1.2. Guest-stay message with all possible fields

Listing 2. Guest-stay message with all possible fields

link:../samples/guest-stays/guest-stay-full.json[role=include]

1.2. Sample guest-stay list messages

1.2.1. Guest-stay list message with multiple guest-stays

Listing 3. Guest-stay list message with multiple guest-stays

link:../samples/guest-stay-lists/guest-stay-list-multiple.json[role=include]

1.3. Sample profile messages

1.3.1. Profile message with commonly used fields

Listing 4. Profile message with commonly used fields

link:../samples/profiles/profile-typical.json[role=include]

1.3.2. Profile message with all possible fields

Listing 5. Profile message with all possible fields

link:../samples/profiles/profile-full.json[role=include]

1.4. Sample simple guest-stay messages

1.4.1. Simple guest-stay message with commonly used fields

Listing 6. Simple guest-stay message with commonly used fields

link:../samples/simple-guest-stays/simple-guest-stay-typical.json[role=include]

1.4.2. Simple guest-stay message with all possible fields

Listing 7. Simple guest-stay message with all possible fields

link:../samples/simple-guest-stays/simple-guest-stay-full.json[role=include]

1.5. Sample simple guest-stay list messages

1.5.1. Simple guest-stay list message with multiple simple guest-stays

Listing 8. Simple guest-stay list message with multiple simple guest-stays

link:../samples/simple-guest-stay-lists/simple-guest-stay-list-multiple.json[role=include]

1.6. Sample guest-stay list result messages

1.6.1. Guest-stay list result message with success result

Listing 9. Guest-stay list result message with success result

link:../samples/guest-stay-list-results/guest-stay-list-result-success.json[role=include]

1.6.2. Guest-stay list result message with status, errors, and warnings only

Listing 10. Guest-stay list result message with status, errors, and warnings only

link:../samples/guest-stay-list-results/guest-stay-list-result-novalue.json[role=include]

1.6.3. Guest-stay list result message with all possible fields

Listing 11. Guest-stay list result message with all possible fields

link:../samples/guest-stay-list-results/guest-stay-list-result-full.json[role=include]

1.7. Sample profile list result messages

1.7.1. Profile list result message with success result

Listing 12. Profile list result message with success result

link:../samples/profile-list-results/profile-list-result-success.json[role=include]

1.7.2. Profile list result message with all possible fields

Listing 13. Profile list result message with all possible fields

link:../samples/profile-list-results/profile-list-result-full.json[role=include]

changelog.adoc