API - How to know what data is expected

Owned by rossc
Oct 11, 2023
1 min read

The API endpoints have validation regarding what data is expected for various fields

To check what the expected data is

  1. Go to Flip API Documentation

  2. Navigate to the endpoint and expand

  3. Then click Schema

 

  1. Navigate to the field in question

For example

a. consignmentType only accepts Pickup, Return or Transfer

Whereas for PackagingType navigate to

a. shippingItems and click the arrow to expand

b. then navigate to ShippingItemModle and click the arrow to expand

c. hen navigate to PackagingType to see the appropriate values

Â