Overview

Overview

Allivet REST API enables you to view our product catalog and use our drop shipping service to power your business. With Allivet REST API you interact with the API in the context of a shop customer, like other RESTful APIs, operates on resources, enabling you to implement storefront-related functionality.

Allivet REST API consists of network of API that handles customer creation/update as well as submit order transaction to do store-front related functionality. Allivet also provides integrator, the capabilities to download our catalogs, and availability of stocks. Product availability will depend on business requirements. This project aims to tailor Allivet Web API with some of customer specific requirements according to your business needs. Endpoints will only be visible to integrators according to permission granted to them.

SecurityAPI Key: Bearer
Responses
200

Success

post/api/Overview
Request samples 
Response samples 
No sample
Auth
Authentication
Generate Bearer Token to grant access to api-endpoints


SecurityAPI Key: Bearer 
Request 
Request Body schema: 
Provide client credentials


clientID
required
string
REQUIRED
             Client username.


 
clientSecretKey
required
string
REQUIRED
             Secret Hash provided to clients to login on the API.


 
apiScope
required
string
REQUIRED
             Scope defines the set of endpoints that clients will be able to access and consume to their system. Visibility of endpoints are controlled by client’s scope policy.


 
storeKey
required
string
REQUIRED
             Storefront Id provided to clients to determine which store the transaction is for.


 
Responses 
200
Return token


401
Scope is not provided or credentials invalid


403
Forbidden Access to API end point


500
Internal Server Error


post/api/Auth
Request samples 
{
  • "clientID": "client-id",
  • "clientSecretKey": "client/sercrEt%Key",
  • "apiScope": "api:<scope>",
  • "storeKey": "store id<string>"
}
Response samples 
application/json
{
  • "validTo": "2021-03-16T22:12:34Z",
  • "value": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJMb2dpbiBUb2tlbiIsImp0aSI6ImFlNWY1M2JhLTcxMjEtNGRlMy05YmIwLWNlYWZiMzBhNjZhYyIsInNjb3BlcyI6ImFwaTp0ZWxlaGVhbHRoIiwidXNlcm5hbWUiOiI1MTUyMDIzMi1CNzI4LTQ5QUEtOTg5RC0zMzRDNDgiLCJleHAiOjE2MDY2MDcxNDQsImlzcyI6IkFsbGl2ZXQuY29tIiwiYXVkIjoiQWxsaXZldC5jb20ifQ.LdZxxF7khM8jdQD7XP7WtT6W5SPrlOiR_ewhAuqVnV4"
}
Products
Get Product By Id
This endpoint will allow you to retrieve product information specific to the Product SKU provided. You may pass URL parameters to these endpoints to search for a particular product.


SecurityAPI Key: Bearer 
Request 
path Parameters
id
required
string or null
REQUIREDUnique id of the product.


 
Responses 
200
Return product.


400
Product id not informed.


404
Product not found


get/api/Products/{id}
Request samples 
Response samples 
{
  "itemName": "10012",
  "brand": "CLOVITE",
  "manufacturer": "Zoetis",
  "itemType": "Matrix Group",
  "itemDescription": "CLOVITE",
  "showBuyButton": "Y",
  "asByPass": "N",
  "active": "A",
  "isRxItem": "Y",
  "isColdItem": "N",
  "isDangerousGoods": "N",
  "isMap": "Y",
  "isP65": "Y",
  "metaData": {
    "seoData": {
      "seTitle": "CLOVITE",
      "seKeywords": "buy clovite online, clovite for dogs, clovite for horses",
      "seDescription": "Call us at 1-877-500-9944 to purchase natural vitamin supplement CLOVITE with our everyday low price guarantee. Order now and Save your and money on AutoShip order.",
      "seAltText": "Order natural vitamin supplement CLOVITE"
    },
    "htmlSummary": "CLOVITE is a natural, high-potency supplement that offers Vitamin B12, Vitamin D, and Vitamin A.",
    "whatIs": "",
    "productFor": "For use in all animal species.",
    "whyUseIt": "CLOVITE is a vitamin-enriched supplement that is safe for any species.",
    "howItWorks": "CLOVITE provides animals with essential vitamins, supporting immune system health.",
    "activeIngredients": "Soybean meal, Soy flour, Vitamin A &amp; D oil, Dicalcium phosphate, Vitamin B12 supplement, Vitamin A &amp; D3 supplement, Choline chloride, Vitamin E supplement, Calcium pantothenate, Niacin, Pyridoxine hydrochloride, Thiamine hydrochloride, Riboflavin, Biotin.",
    "howIsItSold": "-5 lbs -25 lbs",
    "sideEffects": "No known side effects.",
    "specialPrecautions": "",
    "eventOfOverdose": "Contact your closest animal hospital immediately.",
    "howtoStore": "Store in a dry and cool environment.",
    "tip": "CLOVITE is a palatable powder formula that can be dressed or mixed into feed, or combined with milk for nursing foals, calves, baby pigs, puppies and kittens.",
    "htmlDosages": "Young Foals and Weanlings: 1 to 2 tablespoonfuls daily.Brood Mares: (latter half of pregnancy and lactation) 2 tablespoonfuls twice a day. Ponies: 1 tablespoonful daily. Colts, Stallions and Horses in Training: 1 tablespoonful per 400 lb daily. All Farm Animals: 1 to 3 lb to each 100 lb feed.",
    "htmlIngredients": "VITAMIN A VITAMIN D VITAMIN B12"
  },
  "productAttribute": {
    "petType": "Dog",
    "category": "HorseSupplements",
    "lifeStage": [
      "All",
      "Adult",
      "Kitten",
      "Puppy",
      "Senior"
    ],
    "dietary": [
      "Gluten Free",
      "GMO Free",
      "Grain Free"
    ],
    "healthCondition": [
      "Allergies",
      "Bacterial Infections"
    ],
    "flavor": [
      "Strawberry",
      "Orange",
      "Apple"
    ],
    "form": [
      "Liquid",
      "Capsules",
      "Tablets"
    ]
  },
  "matrixItem": [
    {
      "itemName": "10012-05",
      "upcCode": "1877527745411",
      "itemDescription": "CLOVITE 10 lbs",
      "itemType": "Matrix Item",
      "allivetPrice": 55.99,
      "mapPrice": 56.77,
      "showBuyButton": "Y",
      "weightInPounds": 5,
      "lengthInInches": 2,
      "heightInInches": 2.2,
      "widthInInches": 2,
      "active": "A",
      "asByPass": "N",
      "isShippingRestricted": "Y",
      "stateRestricted": [
        "CA",
        "CT",
        "GA",
        "IN"
      ],
      "productAttribute": {
        "petType": "Dog",
        "category": "HorseSupplements",
        "lifeStage": [
          "All",
          "Adult",
          "Kitten",
          "Puppy",
          "Senior"
        ],
        "dietary": [
          "Gluten Free",
          "GMO Free",
          "Grain Free"
        ],
        "healthCondition": [
          "Allergies",
          "Bacterial Infections"
        ],
        "flavor": [
          "Strawberry",
          "Orange",
          "Apple"
        ],
        "form": [
          "Liquid",
          "Capsules",
          "Tablets"
        ]
      }
    }
  ],
  "bundleComponent": [
    {
      "itemName": null,
      "upcCode": null,
      "itemDescription": null,
      "itemType": null,
      "allivetPrice": 0,
      "mapPrice": 0,
      "showBuyButton": "\u0000",
      "weightInPounds": 0,
      "lengthInInches": 0,
      "heightInInches": 0,
      "widthInInches": 0,
      "active": "\u0000",
      "asByPass": "\u0000",
      "isShippingRestricted": "\u0000",
      "stateRestricted": null,
      "productAttribute": null
    }
  ]
}
Get Product List
This endpoint will allow you to retrieve all products based on provided page number. You may pass URL parameters to these endpoints to navigate the pagination.


SecurityAPI Key: Bearer 
Request 
query Parameters
pageno
integer <int32> 
 Default:  1
REQUIREDCurrent page number


 
 Example:  pageno=1
Responses 
200
Return list of product.


400
Pageno not informed.


404
Products not found


get/api/Products
Request samples 
Response samples 
{
  "current_page": 1,
  "data": [
    {
      "itemName": "10012",
      "brand": "CLOVITE",
      "manufacturer": "Zoetis",
      "itemType": "Matrix Group",
      "itemDescription": "CLOVITE",
      "showBuyButton": "Y",
      "asByPass": "N",
      "active": "A",
      "isRxItem": "Y",
      "isColdItem": "N",
      "isDangerousGoods": "N",
      "isMap": "Y",
      "isP65": "Y",
      "metaData": {
        "seoData": {
          "seTitle": "CLOVITE",
          "seKeywords": "buy clovite online, clovite for dogs, clovite for horses",
          "seDescription": "Call us at 1-877-500-9944 to purchase natural vitamin supplement CLOVITE with our everyday low price guarantee. Order now and Save your and money on AutoShip order.",
          "seAltText": "Order natural vitamin supplement CLOVITE"
        },
        "htmlSummary": "CLOVITE is a natural, high-potency supplement that offers Vitamin B12, Vitamin D, and Vitamin A.",
        "whatIs": "",
        "productFor": "For use in all animal species.",
        "whyUseIt": "CLOVITE is a vitamin-enriched supplement that is safe for any species.",
        "howItWorks": "CLOVITE provides animals with essential vitamins, supporting immune system health.",
        "activeIngredients": "Soybean meal, Soy flour, Vitamin A &amp; D oil, Dicalcium phosphate, Vitamin B12 supplement, Vitamin A &amp; D3 supplement, Choline chloride, Vitamin E supplement, Calcium pantothenate, Niacin, Pyridoxine hydrochloride, Thiamine hydrochloride, Riboflavin, Biotin.",
        "howIsItSold": "-5 lbs -25 lbs",
        "sideEffects": "No known side effects.",
        "specialPrecautions": "",
        "eventOfOverdose": "Contact your closest animal hospital immediately.",
        "howtoStore": "Store in a dry and cool environment.",
        "tip": "CLOVITE is a palatable powder formula that can be dressed or mixed into feed, or combined with milk for nursing foals, calves, baby pigs, puppies and kittens.",
        "htmlDosages": "Young Foals and Weanlings: 1 to 2 tablespoonfuls daily.Brood Mares: (latter half of pregnancy and lactation) 2 tablespoonfuls twice a day. Ponies: 1 tablespoonful daily. Colts, Stallions and Horses in Training: 1 tablespoonful per 400 lb daily. All Farm Animals: 1 to 3 lb to each 100 lb feed.",
        "htmlIngredients": "VITAMIN A VITAMIN D VITAMIN B12"
      },
      "productAttribute": {
        "petType": "Dog",
        "category": "HorseSupplements",
        "lifeStage": [
          "All",
          "Adult",
          "Kitten",
          "Puppy",
          "Senior"
        ],
        "dietary": [
          "Gluten Free",
          "GMO Free",
          "Grain Free"
        ],
        "healthCondition": [
          "Allergies",
          "Bacterial Infections"
        ],
        "flavor": [
          "Strawberry",
          "Orange",
          "Apple"
        ],
        "form": [
          "Liquid",
          "Capsules",
          "Tablets"
        ]
      },
      "matrixItem": [
        {
          "itemName": "10012-05",
          "upcCode": "1877527745411",
          "itemDescription": "CLOVITE 10 lbs",
          "itemType": "Matrix Item",
          "allivetPrice": 55.99,
          "mapPrice": 56.77,
          "showBuyButton": "Y",
          "weightInPounds": 5,
          "lengthInInches": 2,
          "heightInInches": 2.2,
          "widthInInches": 2,
          "active": "A",
          "asByPass": "N",
          "isShippingRestricted": "Y",
          "stateRestricted": [
            "CA",
            "CT",
            "GA",
            "IN"
          ],
          "productAttribute": {
            "petType": "Dog",
            "category": "HorseSupplements",
            "lifeStage": [
              "All",
              "Adult",
              "Kitten",
              "Puppy",
              "Senior"
            ],
            "dietary": [
              "Gluten Free",
              "GMO Free",
              "Grain Free"
            ],
            "healthCondition": [
              "Allergies",
              "Bacterial Infections"
            ],
            "flavor": [
              "Strawberry",
              "Orange",
              "Apple"
            ],
            "form": [
              "Liquid",
              "Capsules",
              "Tablets"
            ]
          }
        }
      ],
      "bundleComponent": [
        {
          "itemName": null,
          "upcCode": null,
          "itemDescription": null,
          "itemType": null,
          "allivetPrice": 0,
          "mapPrice": 0,
          "showBuyButton": "\u0000",
          "weightInPounds": 0,
          "lengthInInches": 0,
          "heightInInches": 0,
          "widthInInches": 0,
          "active": "\u0000",
          "asByPass": "\u0000",
          "isShippingRestricted": "\u0000",
          "stateRestricted": null,
          "productAttribute": null
        }
      ]
    }
  ],
  "from": 1,
  "last_page": 1,
  "next_page_url": null,
  "path": "\\/",
  "per_page": 100,
  "prev_page_url": null,
  "to": 1,
  "total": 1
}
Product Stock Availability
This endpoint will allow you to retrieve product availability specific to the Product SKU provided. You may pass URL parameters to these endpoints to search for a particular product.


SecurityAPI Key: Bearer 
Request 
path Parameters
id
required
string or null
REQUIREDUnique id of the product.


 
Responses 
200
Return product.


400
Product id not informed.


404
Product not found


get/api/Products/{id}/availability
Request samples 
Response samples 
No sample
Vets
Search Vets

  

     Http Method 
     Resource 
     Description 
  

  

     GET 
     /api/Vets 
     Gets information of the vets, parameters are required according to combination. 

              1. GET api/Vets/{vetname , vetState} 

              2. GET api/Vets/{phonenumber} 

              3. GET api/Vets/{VetPostalCode}
              		
  


SecurityAPI Key: Bearer 
Request 
query Parameters
vetName
string or null
REQUIREDName of the veterinarian.


 
 Example:  vetName=Anne PEDEN
vetState
string or null
REQUIREDThe state from where vet belongs.


 
 Example:  vetState=NY
vetPhone
string or null
REQUIREDTelephone number of the vet.


 
 Example:  vetPhone=4245689898
vetPostalCode
string or null
REQUIREDPostal ID Address of the vet.


 
 Example:  vetPostalCode=14454
Responses 
200
Success


400
Bad Request


get/api/Vets
Request samples 
Response samples 
No sample
New Vet
This endpoint will allow you to create vet.


SecurityAPI Key: Bearer 
Request 
Request Body schema: application/json
Vet to be created.


vetName
required
string  <= 100 characters 
REQUIRED
            Name of the veterinarian.


 
clinicName
required
string  <= 100 characters 
REQUIRED
            Name of the clinic / hospital of the vet.


 
vetAddress
string or null  <= 200 characters 
OPTIONAL
            Address of the clinic / hospital of the vet.


 
vetCity
required
string  <= 50 characters 
REQUIRED
            The city address of the vet.


 
vetState
required
string  <= 2 characters 
REQUIRED
            The state from where vet belongs.


 
vetPostalCode
required
string  <= 10 characters 
REQUIRED
            Postal ID Address of the vet.


 
vetPhone
required
string  <= 50 characters 
REQUIRED
            Telephone number of the vet.


 
Responses 
200
Success


400
Bad Request


404
Not Found


post/api/Vets
Request samples 
application/json
{
  • "vetName": "Anne Peddon",
  • "clinicName": "BOSSIER ANIMAL HOSPITAL",
  • "vetAddress": "3308 INDUSTRIAL DRIVE",
  • "vetCity": "GENESEO",
  • "vetState": "NY",
  • "vetPostalCode": "14454",
  • "vetPhone": "4245689898"
}
Response samples 
{
  • "vetId": 1545,
  • "vetName": "Anne Peddon",
  • "clinicName": "BOSSIER ANIMAL HOSPITAL",
  • "vetAddress": "3308 INDUSTRIAL DRIVE",
  • "vetCity": "GENESEO",
  • "vetState": "NY",
  • "vetPostalCode": "14454",
  • "vetPhone": "4245689898",
  • "dateCreated": "2020-12-20T04:18:43.0000000",
  • "dateModified": "2020-12-20T04:18:43.0000000"
}
Vet By Id
This endpoint allows you to search vet using unique vet id.


SecurityAPI Key: Bearer 
Request 
path Parameters
vetId
required
integer <int32> 
REQUIREDUnique client vet Id


 
 Example:  1545
Responses 
200
Success


404
Not Found


get/api/Vets/{vetId}
Request samples 
Response samples 
No sample
Orders
Get Order
This endpoint will allow you to get specific order information. You may pass URL parameters to these endpoints to navigate to a specific order by providing the unique id of the order.


SecurityAPI Key: Bearer 
Request 
path Parameters
OrderId
required
string
REQUIREDUnique id of the Order.


 
 Example:  55503648
Responses 
200
Success


400
Bad Request


404
Not Found


get/api/Orders/{OrderId}
Request samples 
Response samples 
No sample
New Order
This endpoint will allow you to Create order.


SecurityAPI Key: Bearer 
Request 
Request Body schema: application/json
Order to be created.


clientId
required
string  <= 30 characters 
REQUIRED
             Company Id Provided to you.


 
clientOrderId
required
string  <= 50 characters 
REQUIRED
             Your Order Id.


 
customerId
required
string  <= 60 characters 
REQUIRED
             The CustomerID you use to identify your customer, it should be unique for every customer, we will create an account for that customer, 
             any next orders, should use the same ID, so we will create that order under that account.
             This is important for a proper Rx handling. This is usually customer email address.


 
customerKeyId
required
string  <= 60 characters 
REQUIRED
             This is your unique customer code. For communication purposes, we are keeping this id on our database.

             Ex: CUST-12345


 
salesOrderDate
required
string  [ 0 .. 200 ] characters 
REQUIRED
             Date the order transaction.


 
shippingMethod
required
string  <= 30 characters 
REQUIRED
            Allowed shipping methods codes:
            
  • GRND
  • 1DAY
  • 2DAY
  • MAPPING
  • GRND – Standard
  • 1day - FedEx Standard Next Day
  • 2day - FedEx 2nd Day


 
billToName
string or null  <= 100 characters 
OPTIONAL
            Name of the customer/business who placed the order.


 
billToAddress
string or null  <= 200 characters 
OPTIONAL
            Billing Address of the customer who placed the order. If not provided will use recipient Address information.


 
billToCity
string or null  <= 50 characters 
OPTIONAL
            City of the customer who placed the order.


 
billToState
string or null  <= 50 characters 
OPTIONAL
            State of the customer who placed the order.


 
billToPostalCode
string or null  <= 10 characters 
OPTIONAL
            Code of the customer who placed the order.


 
billToCountry
string or null  <= 2 characters 
OPTIONAL
            Country of the customer who placed the order.


 
billToPhone
string or null  <= 10 characters 
OPTIONAL
            Your customer Phone number.


 
shipToAddressId
string or null  <= 30 characters 
OPTIONAL
            Your Address Id.The system will validate this id to check if the Recipient Address already exists in the system.

            If value is empty, API will use primary shipping address and update information based on order information submitted.


 
shipToName
required
string  <= 100 characters 
REQUIRED
            Name of the customer who placed the order


 
shipToAddress
required
string  <= 200 characters 
REQUIRED
            Address of the customer who placed the order


 
shipToCity
required
string  <= 50 characters 
REQUIRED
            City of the customer who placed the order


 
shipToState
required
string  <= 50 characters 
REQUIRED
            State of the customer who placed the order


 
shipToPostalCode
required
string  <= 10 characters 
REQUIRED
            Code of the customer who placed the order


 
shipToCountry
required
string  <= 2 characters 
REQUIRED
            Country of the customer who placed the order


 
shipToPhone
required
string  <= 10 characters 
REQUIRED
            Recipient Phone Number


 
isAutoship
required
string  <= 1 characters Y|N
 Default:  "N"
REQUIRED


    
  
  • If Y Yes, Order is marked as autoship order.
    • 
  
  • If N No, order is regular or reshipment order transaction
    • 

 
isReship
string or null  <= 1 characters Y|N
 Default:  "N"
OPTIONAL


    
  
  • If Y Yes, Order is marked as reshipment order.
    • 
  
  • If N No, order is either regular or autoship order transaction
    • 

 
reasonCode
string or null  <= 1 characters 0|1|2|3|4|5|6|7|8|9
OPTIONAL


    
  
  • If IsReship = Yes, Reason Code must be required.
    • 
  
  • If IsReship = No, this can be empty.
    • 

 
originalClientOrderId
string or null  <= 30 characters 
OPTIONAL


    
  
  • If IsReship = Yes, OriginalClientOrderId must be required.
    • 
  
  • If IsReship = No, this can be empty.
    • 

 
required
Array of objects (CreateOrderDetailRequest)   non-empty 
REQUIRED
             Order details.


 
Responses 
200
Success


400
Bad Request


404
Not Found


post/api/Orders
Request samples 
application/json
{
  • "clientId": "DropshipClient",
  • "clientOrderId": "26849758",
  • "customerId": "johndoe@gmail.com",
  • "customerKeyId": "ac11JDiERGcI32X3ILwjahBAYM",
  • "salesOrderDate": "2014-02-23T20:01:08-08:00",
  • "shippingMethod": "GRND",
  • "billToName": "John Doe",
  • "billToAddress": "23200 Summer Glenn",
  • "billToCity": "Harbor City",
  • "billToState": "CA",
  • "billToPostalCode": "90717",
  • "billToCountry": "US",
  • "billToPhone": "4245673448",
  • "shipToAddressId": "ac1aJDiERGcI32X3ILwjahBAYM",
  • "shipToName": "John Doe",
  • "shipToAddress": "23200 Summer Glenn",
  • "shipToCity": "Harbor City",
  • "shipToState": "CA",
  • "shipToPostalCode": "90717",
  • "shipToCountry": "US",
  • "shipToPhone": "4245673448",
  • "isAutoship": "N",
  • "isReship": "N",
  • "reasonCode": "0",
  • "originalClientOrderId": "0",
  • "customerSalesOrderDetail": [
    ]
}
Response samples 
{
  • "salesOrderCode": "SO-2182630",
  • "clientId": "DropshipClient",
  • "clientOrderId": "26849758",
  • "customerId": "johndoe@gmail.com",
  • "customerKeyId": "ac11JDiERGcI32X3ILwjahBAYM",
  • "salesOrderDate": "2014-02-23T20:01:08-08:00",
  • "shippingMethod": "Allivet Shipping",
  • "billToName": "John Doe",
  • "billToAddress": "23200 Summer Glenn",
  • "billToCity": "Harbor City",
  • "billToState": "CA",
  • "billToPostalCode": "90717",
  • "billToCountry": "US",
  • "billToPhone": "4245673448",
  • "shipToAddressId": "ac1aJDiERGcI32X3ILwjahBAYM",
  • "shipToName": "John Doe",
  • "shipToAddress": "23200 Summer Glenn",
  • "shipToCity": "Harbor City",
  • "shipToState": "CA",
  • "shipToPostalCode": "90717",
  • "shipToCountry": "US",
  • "shipToPhone": "4245673448",
  • "subTotal": 44.18,
  • "freight": 48.2,
  • "freightTax": 48.2,
  • "tax": 20.9,
  • "total": 57.09,
  • "isAutoship": "Y",
  • "isReship": "N",
  • "reasonCode": "0",
  • "originalClientOrderId": "N/A",
  • "orderStatus": "Waiting for Rx",
  • "dateCreated": "2020-12-20T04:18:43.0000000",
  • "dateModified": "2020-12-20T04:18:43.0000000",
  • "customerSalesOrderDetail": [
    ],
  • "warnings": {
    },
  • "statusCode": 200
}
Update Order
This endpoint will allow you to Update order.


SecurityAPI Key: Bearer 
Request 
Request Body schema: application/json
Order to be updated.


clientId
required
string  <= 30 characters 
REQUIRED
             Company Id Provided to you.


 
clientOrderId
required
string  <= 50 characters 
REQUIRED
             Your Order Id.


 
customerId
required
string  <= 60 characters 
REQUIRED
             The CustomerID you use to identify your customer, it should be unique for every customer, we will create an account for that customer, 
             any next orders, should use the same ID, so we will create that order under that account.
             This is important for a proper Rx handling. This is usually customer email address.


 
customerKeyId
required
string  <= 60 characters 
REQUIRED
             This is your unique customer code. For communication purposes, we are keeping this id on our database.

             Ex: CUST-12345


 
salesOrderDate
required
string  [ 0 .. 200 ] characters 
REQUIRED
             Date the order transaction.


 
shippingMethod
required
string  <= 30 characters 
REQUIRED
            Allowed shipping methods codes:
            
  • GRND
  • 1DAY
  • 2DAY
  • MAPPING
  • GRND – Standard
  • 1day - FedEx Standard Next Day
  • 2day - FedEx 2nd Day


 
billToName
string or null  <= 100 characters 
OPTIONAL
            Name of the customer/business who placed the order.


 
billToAddress
string or null  <= 200 characters 
OPTIONAL
            Billing Address of the customer who placed the order. If not provided will use recipient Address information.


 
billToCity
string or null  <= 50 characters 
OPTIONAL
            City of the customer who placed the order.


 
billToState
string or null  <= 50 characters 
OPTIONAL
            State of the customer who placed the order.


 
billToPostalCode
string or null  <= 10 characters 
OPTIONAL
            Code of the customer who placed the order.


 
billToCountry
string or null  <= 2 characters 
OPTIONAL
            Country of the customer who placed the order.


 
billToPhone
string or null  <= 10 characters 
OPTIONAL
            Your customer Phone number.


 
shipToAddressId
string or null  <= 30 characters 
OPTIONAL
            Your Address Id.The system will validate this id to check if the Recipient Address already exists in the system.

            If value is empty, API will use primary shipping address and update information based on order information submitted.


 
shipToName
required
string  <= 100 characters 
REQUIRED
            Name of the customer who placed the order


 
shipToAddress
required
string  <= 200 characters 
REQUIRED
            Address of the customer who placed the order


 
shipToCity
required
string  <= 50 characters 
REQUIRED
            City of the customer who placed the order


 
shipToState
required
string  <= 50 characters 
REQUIRED
            State of the customer who placed the order


 
shipToPostalCode
required
string  <= 10 characters 
REQUIRED
            Code of the customer who placed the order


 
shipToCountry
required
string  <= 2 characters 
REQUIRED
            Country of the customer who placed the order


 
shipToPhone
required
string  <= 10 characters 
REQUIRED
            Recipient Phone Number


 
isAutoship
required
string  <= 1 characters Y|N
 Default:  "N"
REQUIRED


    
  
  • If Y Yes, Order is marked as autoship order.
    • 
  
  • If N No, order is regular or reshipment order transaction
    • 

 
isReship
string or null  <= 1 characters Y|N
 Default:  "N"
OPTIONAL


    
  
  • If Y Yes, Order is marked as reshipment order.
    • 
  
  • If N No, order is either regular or autoship order transaction
    • 

 
reasonCode
string or null  <= 1 characters 0|1|2|3|4|5|6|7|8|9
OPTIONAL


    
  
  • If IsReship = Yes, Reason Code must be required.
    • 
  
  • If IsReship = No, this can be empty.
    • 

 
originalClientOrderId
string or null  <= 30 characters 
OPTIONAL


    
  
  • If IsReship = Yes, OriginalClientOrderId must be required.
    • 
  
  • If IsReship = No, this can be empty.
    • 

 
required
Array of objects (CreateOrderDetailRequest)   non-empty 
REQUIRED
             Order details.


 
Responses 
200
Success


400
Bad Request


404
Not Found


put/api/Orders
Request samples 
application/json
{
  • "clientId": "DropshipClient",
  • "clientOrderId": "26849758",
  • "customerId": "johndoe@gmail.com",
  • "customerKeyId": "ac11JDiERGcI32X3ILwjahBAYM",
  • "salesOrderDate": "2014-02-23T20:01:08-08:00",
  • "shippingMethod": "GRND",
  • "billToName": "John Doe",
  • "billToAddress": "23200 Summer Glenn",
  • "billToCity": "Harbor City",
  • "billToState": "CA",
  • "billToPostalCode": "90717",
  • "billToCountry": "US",
  • "billToPhone": "4245673448",
  • "shipToAddressId": "ac1aJDiERGcI32X3ILwjahBAYM",
  • "shipToName": "John Doe",
  • "shipToAddress": "23200 Summer Glenn",
  • "shipToCity": "Harbor City",
  • "shipToState": "CA",
  • "shipToPostalCode": "90717",
  • "shipToCountry": "US",
  • "shipToPhone": "4245673448",
  • "isAutoship": "N",
  • "isReship": "N",
  • "reasonCode": "0",
  • "originalClientOrderId": "0",
  • "customerSalesOrderDetail": [
    ]
}
Response samples 
{
  • "salesOrderCode": "SO-2182630",
  • "clientId": "DropshipClient",
  • "clientOrderId": "26849758",
  • "customerId": "johndoe@gmail.com",
  • "customerKeyId": "ac11JDiERGcI32X3ILwjahBAYM",
  • "salesOrderDate": "2014-02-23T20:01:08-08:00",
  • "shippingMethod": "Allivet Shipping",
  • "billToName": "John Doe",
  • "billToAddress": "23200 Summer Glenn",
  • "billToCity": "Harbor City",
  • "billToState": "CA",
  • "billToPostalCode": "90717",
  • "billToCountry": "US",
  • "billToPhone": "4245673448",
  • "shipToAddressId": "ac1aJDiERGcI32X3ILwjahBAYM",
  • "shipToName": "John Doe",
  • "shipToAddress": "23200 Summer Glenn",
  • "shipToCity": "Harbor City",
  • "shipToState": "CA",
  • "shipToPostalCode": "90717",
  • "shipToCountry": "US",
  • "shipToPhone": "4245673448",
  • "subTotal": 44.18,
  • "freight": 48.2,
  • "freightTax": 48.2,
  • "tax": 20.9,
  • "total": 57.09,
  • "isAutoship": "Y",
  • "isReship": "N",
  • "reasonCode": "0",
  • "originalClientOrderId": "N/A",
  • "orderStatus": "Waiting for Rx",
  • "dateCreated": "2020-12-20T04:18:43.0000000",
  • "dateModified": "2020-12-20T04:18:43.0000000",
  • "customerSalesOrderDetail": [
    ],
  • "warnings": {
    },
  • "statusCode": 200
}
Cancel Order
This endpoint will allow you to Cancels an order based on the provided External Order ID.


SecurityAPI Key: Bearer 
Request 
path Parameters
ExternalOrderId
required
string
REQUIREDUnique id of the Order.


 
 Example:  55503648
Responses 
200
Order Successfully Voided!


400
Bad Request


404
The Order not found.


put/api/Orders/{ExternalOrderId}/cancel
Request samples 
Response samples 
application/json
{
  • "errormessage": "string",
  • "statuscode": "string",
  • "statusmessage": "string"
}
Customers
Get Customer
This endpoint will allow you to get specific customer information. You may pass URL parameters to these endpoints to navigate to a specific customer by providing the unique id of the customer.


SecurityAPI Key: Bearer 
Request 
path Parameters
clientCustomerNo
required
string or null
REQUIREDUnique id of the customer.


 
 Example:  ACS-123456
Responses 
200
Return customer.


400
Customer id not informed.


404
Customer not found.


get/api/salesforce/Customers/{clientCustomerNo}
Request samples 
Response samples 
application/json
{
  • "customerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  • "email": "johndoe@gmail.com",
  • "clientCustomerNo": "ACS-123456",
  • "clientAutoshipId": "437451",
  • "clientRxId": "7451",
  • "clientReorderId": "4374",
  • "clientCustomerId": "56437451",
  • "firstName": "John",
  • "middleName": "Mid",
  • "lastName": "Doe",
  • "customerName": "John Doe",
  • "mobile": "4245673448",
  • "isOkToReceiveEmail": "Y",
  • "perksIDNumber": "9587854712",
  • "dateCreated": "2020-12-20T04:18:43.0000000",
  • "dateModified": "2020-12-20T04:18:43.0000000",
  • "customerBilling": [
    ],
  • "customerShipTo": [
    ],
  • "warnings": {
    },
  • "statusCode": 200
}
Register Customer
This endpoint allows you to register a new customer from your site. Email Address should be unique per customer.


SecurityAPI Key: Bearer 
Request 
Request Body schema: application/json
The Customer properties.


email
required
string  [ 0 .. 100 ] characters 
REQUIRED
            Email Address of the customer.


 
clientCustomerNo
required
string  [ 0 .. 100 ] characters 
REQUIRED
            Client Customer No


 
clientAutoshipId
required
string  [ 0 .. 200 ] characters 
REQUIRED
            Client Auto ship Id


 
clientRxId
required
string  [ 0 .. 200 ] characters 
REQUIRED
            Client Rx Id


 
clientReorderId
required
string  [ 0 .. 200 ] characters 
REQUIRED
            Client Reorder Id


 
clientCustomerId
string or null  [ 0 .. 30 ] characters 
REQUIRED
            Customer Id


 
firstName
required
string  [ 0 .. 100 ] characters 
REQUIRED
            Firstname of the customer.


 
middleName
string or null  [ 0 .. 50 ] characters 
OPTIONAL
            Middlename of the customer.


 
lastName
required
string  [ 0 .. 100 ] characters 
REQUIRED
            Lastname of the customer.


 
customerName
required
string  [ 0 .. 100 ] characters 
REQUIRED
            Name of the customer.


 
billToAddressId
string or null  [ 0 .. 100 ] characters 
OPTIONAL
             address id


 
billToAddress
string or null  [ 0 .. 200 ] characters 
OPTIONAL
            The location of the customer.


 
billToCity
string or null  [ 0 .. 50 ] characters 
OPTIONAL
            The city address of the customer.


 
billToState
string or null  [ 0 .. 50 ] characters 
OPTIONAL
            The state from where customer belongs.


 
billToPostalCode
string or null  [ 0 .. 10 ] characters 
OPTIONAL
            Postal ID Address of the customer


 
billToCountry
string or null  [ 0 .. 2 ] characters 
OPTIONAL
            The country from where the customer is located


 
billToPhone
string or null  [ 0 .. 50 ] characters 
OPTIONAL
            Contact information of the customer.


 
Array of objects or null (CustomerCreateShipToRequest) 
Customer Ship


 
password
string or null  [ 0 .. 12 ] characters 
Password of the customer.


 
isOkToReceiveEmail
string or null  <= 1 characters Y|N
 Default:  "Y"
Yes! I’d like to receive coupons and special offers by email


 
perksIDNumber
string or null  [ 0 .. 50 ] characters 
My Perks Id.


 
Responses 
200
The customer was created with warnings.


400
The customer has an invalid format.


post/api/salesforce/Customers
Request samples 
application/json
{
  • "email": "johndoe@gmail.com",
  • "clientCustomerNo": "ACS-123456",
  • "clientAutoshipId": "437451",
  • "clientRxId": "7451",
  • "clientReorderId": "4374",
  • "clientCustomerId": "56437",
  • "firstName": "John",
  • "middleName": "Mid",
  • "lastName": "Doe",
  • "customerName": "John Doe",
  • "billToAddressId": "123456",
  • "billToAddress": "23200 Summer Glenn",
  • "billToCity": "Harbor City",
  • "billToState": "CA",
  • "billToPostalCode": "90717",
  • "billToCountry": "US",
  • "billToPhone": "4245673448",
  • "customerShipTo": [
    ],
  • "password": "Abcdef123456",
  • "isOkToReceiveEmail": "Y",
  • "perksIDNumber": "9587854712"
}
Response samples 
application/json
{
  • "customerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  • "email": "johndoe@gmail.com",
  • "clientCustomerNo": "ACS-123456",
  • "clientAutoshipId": "437451",
  • "clientRxId": "7451",
  • "clientReorderId": "4374",
  • "clientCustomerId": "56437451",
  • "firstName": "John",
  • "middleName": "Mid",
  • "lastName": "Doe",
  • "customerName": "John Doe",
  • "mobile": "4245673448",
  • "isOkToReceiveEmail": "Y",
  • "perksIDNumber": "9587854712",
  • "dateCreated": "2020-12-20T04:18:43.0000000",
  • "dateModified": "2020-12-20T04:18:43.0000000",
  • "customerBilling": [
    ],
  • "customerShipTo": [
    ],
  • "warnings": {
    },
  • "statusCode": 200
}
Update Customer
This endpoint allows you to update customer information. You may pass URL parameters to these endpoints to update a specific customer.


SecurityAPI Key: Bearer 
Request 
query Parameters
clientCustomerNo
string or null
REQUIREDUnique id of the customer.


 
 Example:  clientCustomerNo=ACS-123456
Request Body schema: application/json
The Customer properties.


firstName
required
string  [ 0 .. 100 ] characters 
REQUIRED
            Firstname of the customer.


 
lastName
required
string  [ 0 .. 100 ] characters 
REQUIRED
            Lastname of the customer.


 
telephone
required
string  [ 0 .. 50 ] characters 
REQUIRED
            Your customer Phone number.


 
email
required
string  [ 0 .. 100 ] characters 
REQUIRED
            Email Address of the customer.


 
clientAutoshipId
string or null  [ 0 .. 200 ] characters 
OPTIONAL
            Client Auto ship Id


 
clientRxId
string or null  [ 0 .. 200 ] characters 
OPTIONAL
            Client Rx Id


 
clientReorderId
string or null  [ 0 .. 200 ] characters 
OPTIONAL
            Client Reorder Id


 
clientCustomerId
string or null  [ 0 .. 30 ] characters 
OPTIONAL
            Client Customer Id


 
mobile
string or null  [ 0 .. 50 ] characters 
OPTIONAL
            Your customer Mobile number.


 
isOkToReceiveEmail
string or null  <= 1 characters Y|N
 Default:  "Y"
OPTIONAL
            Yes! I’d like to receive coupons and special offers by email


 
perksIDNumber
string or null  [ 0 .. 50 ] characters 
OPTIONAL
            My Perks Id.


 
Responses 
200
The customer was created with warnings.


400
The customer has an invalid format.


put/api/salesforce/Customers
Request samples 
application/json
{
  • "firstName": "John",
  • "lastName": "Doe",
  • "telephone": "4245673448",
  • "email": "johndoe@gmail.com",
  • "clientAutoshipId": "437451",
  • "clientRxId": "7451",
  • "clientReorderId": "4374",
  • "clientCustomerId": "56437451",
  • "mobile": "4245673448",
  • "isOkToReceiveEmail": "Y",
  • "perksIDNumber": "9587854712"
}
Response samples 
application/json
{
  • "customerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  • "email": "johndoe@gmail.com",
  • "clientCustomerNo": "ACS-123456",
  • "clientAutoshipId": "437451",
  • "clientRxId": "7451",
  • "clientReorderId": "4374",
  • "clientCustomerId": "56437451",
  • "firstName": "John",
  • "middleName": "Mid",
  • "lastName": "Doe",
  • "customerName": "John Doe",
  • "mobile": "4245673448",
  • "isOkToReceiveEmail": "Y",
  • "perksIDNumber": "9587854712",
  • "dateCreated": "2020-12-20T04:18:43.0000000",
  • "dateModified": "2020-12-20T04:18:43.0000000",
  • "customerBilling": [
    ],
  • "customerShipTo": [
    ],
  • "warnings": {
    },
  • "statusCode": 200
}
New Address
This endpoint allows you to add new billing/shipping address and assign it as primary billing/shipping address of the customer.


SecurityAPI Key: Bearer 
Request 
path Parameters
clientCustomerNo
required
string or null
REQUIREDUnique id of the customer.


 
 Example:  ACS-123456
Request Body schema: application/json
The Customer Address properties.


addressType
required
string  [ 0 .. 200 ] characters Shipping|Billing
REQUIRED
            Address Type.


 
isPrimary
required
stringY|N
REQUIRED
            Set the address as primary billing or shipping address depending on the type.


 
addressId
required
string  [ 0 .. 100 ] characters 
REQUIRED
            Unique Id of the address.


 
name
required
string  [ 0 .. 100 ] characters 
REQUIRED
            Name of the customer/recipient..


 
address
required
string  [ 0 .. 200 ] characters 
REQUIRED
            Address of the customer/recipient.


 
city
required
string  [ 0 .. 50 ] characters 
REQUIRED
            City Address of the customer/recipient.


 
state
required
string  [ 0 .. 50 ] characters 
REQUIRED
            State code of the customer/recipient.


 
postalCode
required
string  [ 0 .. 10 ] characters 
REQUIRED
            Postal Code of the customer/recipient.


 
country
required
string  [ 0 .. 2 ] characters 
REQUIRED
            Country information the customer/recipient.


 
phone
string or null  [ 0 .. 50 ] characters 
OPTIONAL
            Contact information the customer/recipient.


 
Responses 
200
The customer address was created successfully.


201
Success


400
The Customer address has invalid format.


post/api/salesforce/Customers/{clientCustomerNo}/Address
Request samples 
application/json
{
  • "addressType": "Billing",
  • "isPrimary": "Y",
  • "addressId": "123456",
  • "name": "John Doe",
  • "address": "23200 Summer Glenn",
  • "city": "Harbor City",
  • "state": "CA",
  • "postalCode": "90717",
  • "country": "US",
  • "phone": "4245673448"
}
Response samples 
application/json
{
  • "clientCustomerNo": "123456",
  • "address": [
    ]
}
Set Primary Address
This endpoint allows you to assign primary billing/shipping address of the customer.


SecurityAPI Key: Bearer 
Request 
path Parameters
clientCustomerNo
required
string or null
REQUIREDUnique id of the customer.


 
 Example:  ACS-123456
addressId
required
string or null
REQUIREDUnique Id of the address.


 
 Example:  123456
Request Body schema: application/json
Address properties.


addressType
required
string  [ 0 .. 200 ] characters Shipping|Billing
REQUIRED
            Type of Address (Billing or Shipping)


 
isPrimary
required
stringY|N
REQUIRED
            Set the address as primary billing or shipping address depending on the type.


 
name
required
string  [ 0 .. 100 ] characters 
REQUIRED
            Name of the customer/recipient.


 
address
required
string  [ 0 .. 200 ] characters 
REQUIRED
            Address of the customer/recipient.


 
city
required
string  [ 0 .. 50 ] characters 
REQUIRED
            City Address of the customer/recipient.


 
state
required
string  [ 0 .. 50 ] characters 
REQUIRED
            State code of the customer/recipient.


 
postalCode
required
string  [ 0 .. 10 ] characters 
REQUIRED
            Postal Code of the customer/recipient.


 
country
required
string  [ 0 .. 2 ] characters 
REQUIRED
            Country information the customer/recipient.


 
phone
string or null  [ 0 .. 50 ] characters 
OPTIONAL
            Contact information the customer/recipient.


 
Responses 
200
The customer address was updated successfully.


400
The Customer address has invalid format.


404
The Customer address not found.


put/api/salesforce/Customers/{clientCustomerNo}/Address/{addressId}
Request samples 
application/json
{
  • "addressType": "Billing",
  • "isPrimary": "Y",
  • "name": "John Doe",
  • "address": "23200 Summer Glenn",
  • "city": "Harbor City",
  • "state": "CA",
  • "postalCode": "90717",
  • "country": "US",
  • "phone": "4245673448"
}
Response samples 
application/json
{
  • "clientCustomerNo": "123456",
  • "address": [
    ]
}
Delete Primary Address
This endpoint allows you to delete billing/shipping address of the customer.


SecurityAPI Key: Bearer 
Request 
path Parameters
clientCustomerNo
required
string or null
REQUIREDUnique id of the customer.


 
 Example:  ACS-123456
addressId
required
string or null
REQUIREDUnique Id of the address.


 
 Example:  123456
Responses 
200
The customer address was deleted successfully.


400
The Customer address has invalid format.


404
The Customer address not found.


delete/api/salesforce/Customers/{clientCustomerNo}/Address/{addressId}
Request samples 
Response samples 
application/json
{
  • "clientCustomerNo": "123456",
  • "address": [
    ]
}
New Vet
This endpoint allows you to register a new vet. You may pass URL parameters to these endpoints to add vet to a specific customer.


SecurityAPI Key: Bearer 
Request 
path Parameters
clientCustomerNo
required
string or null
REQUIREDUnique id of the customer.


 
 Example:  ACS-123456
Request Body schema: application/json
Veterinarian data.


clientVetId
required
string  <= 200 characters 
REQUIRED
            If client will be using Allivet's Vet Search this vet Id is Allivet's unique Vet Id.
 
            If the client wishes to use their vet system this will be client's VetId. This will be important for the system to know if the vet exists in the system already. If not, the system automatically creates the records and any succeeding request will use this id as validation.


 
vetName
required
string  <= 100 characters 
REQUIRED
            Name of the veterinarian.


 
clinicName
string or null  <= 100 characters 
OPTIONAL
            Name of the clinic / hospital of the vet.


 
vetPhone
required
string  <= 50 characters 
REQUIRED
            Telephone number of the vet.


 
vetCity
string or null  <= 50 characters 
OPTIONAL
            The city address of the vet.


 
vetState
required
string  <= 2 characters 
REQUIRED
            The state from where vet belongs.


 
vetPostalCode
string or null  <= 10 characters 
OPTIONAL
            Postal ID Address of the vet.


 
cbExternalCode
string or null  <= 100 characters 
OPTIONAL
            Id of veterinarian.


 
Responses 
200
The vet was created successfully.


201
Success


400
The vet has an invalid format.


post/api/salesforce/Customers/{clientCustomerNo}/Vet
Request samples 
application/json
{
  • "clientVetId": "89742",
  • "vetName": "Anne Peddon",
  • "clinicName": "BOSSIER ANIMAL HOSPITAL",
  • "vetPhone": "4245689898",
  • "vetCity": "GENESEO",
  • "vetState": "NY",
  • "vetPostalCode": "14454",
  • "cbExternalCode": ""
}
Response samples 
application/json
{
  • "clientCustomerNo": "string",
  • "customerVet": {
    },
  • "warnings": {
    },
  • "statusCode": 200
}
Remove Vet
This endpoint allows you to remove a vet linked to a specific customer. You may pass URL parameters to these endpoints to remove a vet from a specific customer.


SecurityAPI Key: Bearer 
Request 
path Parameters
clientCustomerNo
required
string or null
REQUIREDUnique id of the customer.


 
 Example:  ACS-123456
clientVetId
required
string or null
REQUIREDIf client will be using Allivet's Vet Search this vet Id is Allivet's unique Vet Id.


 
 Example:  89742
Responses 
200
The customer vet was deleted successfully.


400
Bad Request


404
The Customer vet not found.


put/api/salesforce/Customers/{clientCustomerNo}/Vet/{clientVetId}/Remove
Request samples 
Response samples 
application/json
{
  • "clientCustomerNo": "string",
  • "customerVet": {
    },
  • "warnings": {
    },
  • "statusCode": 200
}
New Customer Pet
This endpoint will allow you to register a new pet to a specific customer. You may pass URL parameters to these endpoints to add a pet to a specific customer.


SecurityAPI Key: Bearer 
Request 
path Parameters
clientCustomerNo
required
string or null
REQUIREDUnique id of the customer.


 
 Example:  ACS-123456
Request Body schema: application/json
pet properties.


clientPetId
required
string  [ 0 .. 200 ] characters 
REQUIRED
            Unique id of the pet.


 
petName
required
string  [ 0 .. 100 ] characters 
REQUIRED
            Name of the Pet.


 
petOwner
required
string  [ 0 .. 100 ] characters 
REQUIRED
            Name owner of the Pet.


 
petType
required
string  [ 0 .. 10 ] characters 
REQUIRED


         Pet Type
         Any of the following codes:
        <ul><li>Dog</li><li>Cat</li><li>Horse</li><li>Bird</li><li>Camel</li><li>Ferret</li><li>Fish</li><li>Goat</li><li>Pig</li><li>Hamster</li><li>Iguana</li><li>Rabbit</li><li>Rat</li><li>Snake</li><li>Turtle</li><li>Cattle</li><li>Chicken</li><li>Guinea Pig</li><li>Llama</li><li>Primate</li><li>Reptiles</li><li>Rodent</li><li>Ruminant</li><li>Sheep</li><li>Swine</li><li>Turkey</li><li>Other</li></ul>



 
petBreed
string or null  [ 0 .. 40 ] characters 
OPTIONAL
            Breed of the Pet.


 
specialType
string or null  [ 0 .. 10 ] characters 
OPTIONAL
            Special Pet Type


 
petGender
required
string  [ 0 .. 1 ] characters F|M
REQUIRED
            Pet gender.
            
  • F - Female
  • M - Male


 
petAge
required
string  [ 0 .. 10 ] characters 0-1 years|2-3 years|4-5 years|6-7 years|8-9 y...
REQUIRED
             Pet Age.
             Use any of the following codes:
            
  • 0-1 years
  • 2-3 years
  • 4-5 years
  • 6-7 years
  • 8-9 years
  • 10+ years
  • Unknown


 
petDateOfBirth
string or null  [ 0 .. 10 ] characters ^(\d{1,2})(\/|-)(\d{1,2})(\/|-)(\d{4})$
OPTIONAL
            Birth Date of the pet.


 
petWeight
required
number <double>   [ 0 .. 99999999.99 ] 
REQUIRED
            Weight of the pet. Value should be in pounds metric.


 
medicalAllergies
string or null  [ 0 .. 400 ] characters 
OPTIONAL
            Descriptive Text.


 
medicationIsTaking
string or null  [ 0 .. 400 ] characters 
OPTIONAL
            Descriptive Text.


 
medicalConditions
string or null  [ 0 .. 400 ] characters 
OPTIONAL
            Descriptive Text.


 
isPregnant
required
string  [ 0 .. 1 ] characters Y|N
REQUIRED
            Pet is Pregnant.
            
  • Y - Yes
  • N - No


 
isDeceased
required
string  [ 0 .. 1 ] characters Y|N
REQUIRED
            Pet is Deceased.
            
  • Y - Yes
  • N - No


 
image
string or null  [ 0 .. 40 ] characters 
OPTIONAL
            Pet image.


 
Responses 
200
The pet was created successfully.


400
Bad Request


404
The Customer not found.


post/api/salesforce/Customers/{clientCustomerNo}/Pet
Request samples 
application/json
{
  • "clientPetId": "123456",
  • "petName": "Lovely",
  • "petOwner": "John Doe",
  • "petType": "Bird",
  • "petBreed": "Labrador Retriever Dog",
  • "specialType": "Alligators",
  • "petGender": "F",
  • "petAge": "6-7 years",
  • "petDateOfBirth": "03/09/2009",
  • "petWeight": 95.5,
  • "medicalAllergies": "Sentinel made her have skin lesions and caused behavior. Doctor is aware of this.",
  • "medicationIsTaking": "Prednisone Tabs 5mg, Methocarbamol Tabs 500mg.",
  • "medicalConditions": "Antibiotic for stomach issue; medicated shampoo for skin irritation.",
  • "isPregnant": "Y",
  • "isDeceased": "N",
  • "image": ""
}
Response samples 
application/json
{
  • "clientCustomerNo": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  • "customerPet": [
    ],
  • "warnings": {
    },
  • "statusCode": 200
}
Update Customer Pet
This endpoint will allow you to update specific pet information of the customer. You may pass URL parameters to these endpoints to update pet information of a specific customer.


SecurityAPI Key: Bearer 
Request 
path Parameters
clientCustomerNo
required
string or null
REQUIREDUnique id of the customer.


 
 Example:  ACS-123456
query Parameters
clientPetId
string or null
REQUIREDUnique id of the pet.


 
 Example:  clientPetId=12345
Request Body schema: application/json
pet properties.


petName
required
string  [ 0 .. 100 ] characters 
REQUIRED
            Name of the Pet.


 
petOwner
required
string  [ 0 .. 100 ] characters 
REQUIRED
            Owner of the Pet.


 
petType
required
string  [ 0 .. 10 ] characters 
REQUIRED
             Pet Type
             Any of the following codes:
             
  • Dog
  • Cat
  • Horse
  • Bird
  • Camel
  • Ferret
  • Fish
  • Goat
  • Pig
  • Hamster
  • Iguana
  • Rabbit
  • Rat
  • Snake
  • Turtle
  • Cattle
  • Chicken
  • Guinea Pig
  • Llama
  • Primate
  • Reptiles
  • Rodent
  • Ruminant
  • Sheep
  • Swine
  • Turkey
  • Other


 
petBreed
string or null  [ 0 .. 40 ] characters 
OPTIONAL
            Breed of the Pet.


 
specialType
string or null  [ 0 .. 10 ] characters 
OPTIONAL
            Special Pet Type


 
petGender
required
string  [ 0 .. 1 ] characters F|M
REQUIRED
            Pet gender.
            
  • F - Female
  • M - Male


 
petAge
required
string  [ 0 .. 10 ] characters 0-1 years|2-3 years|4-5 years|6-7 years|8-9 y...
REQUIRED
            Pet Age.
            Use any of the following codes:
            
  • 0-1 years
  • 2-3 years
  • 4-5 years
  • 6-7 years
  • 8-9 years
  • 10+ years
  • Unknown


 
petDateOfBirth
string or null^(\d{1,2})(\/|-)(\d{1,2})(\/|-)(\d{4})$
OPTIONAL
            Birth Date of the pet.


 
petWeight
required
number <double>   [ 0 .. 99999999.99 ] 
REQUIRED
            Weight of the pet. Value should be in pounds metric.


 
medicalAllergies
string or null  [ 0 .. 400 ] characters 
OPTIONAL
            Specify pet’s medical allergies information.


 
medicationIsTaking
string or null  [ 0 .. 400 ] characters 
OPTIONAL
            Specify any medication the pet is taking.


 
medicalConditions
string or null  [ 0 .. 400 ] characters 
OPTIONAL
            Specify medical condition of the pet.


 
isPregnant
required
string  [ 0 .. 1 ] characters Y|N
REQUIRED
            Pet is Pregnant.
            
  • Y - Yes
  • N - No


 
isDeceased
required
string  [ 0 .. 1 ] characters Y|N
REQUIRED
            Pet is Deceased.
            
  • Y - Yes
  • N - No


 
image
string or null  [ 0 .. 40 ] characters 
OPTIONAL
            Pet image.


 
Responses 
200
The pet was updated successfully.


400
Bad Request


404
The Customer Pet not found.


put/api/salesforce/Customers/{clientCustomerNo}/Pet/clientPetId
Request samples 
application/json
{
  • "petName": "Lovely",
  • "petOwner": "John Doe",
  • "petType": "Bird",
  • "petBreed": "Labrador Retriever Dog",
  • "specialType": "Alligators",
  • "petGender": "F",
  • "petAge": "6-7 years",
  • "petDateOfBirth": "03/09/2009",
  • "petWeight": 95.5,
  • "medicalAllergies": "Sentinel made her have skin lesions and caused behavior. Doctor is aware of this.",
  • "medicationIsTaking": "Prednisone Tabs 5mg, Methocarbamol Tabs 500mg.",
  • "medicalConditions": "Antibiotic for stomach issue; medicated shampoo for skin irritation.",
  • "isPregnant": "Y",
  • "isDeceased": "N",
  • "image": ""
}
Response samples 
application/json
{
  • "clientCustomerNo": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  • "customerPet": [
    ],
  • "warnings": {
    },
  • "statusCode": 200
}
Delete Customer Pet
This endpoint will allow you to delete specific pet information of the customer. You may pass URL parameters to these endpoints to delete pet information of specific customer.


SecurityAPI Key: Bearer 
Request 
path Parameters
clientCustomerNo
required
string or null
REQUIREDUnique id of the customer.


 
 Example:  ACS-123456
clientPetId
required
string or null
REQUIREDUnique id of the pet.


 
 Example:  12345
Responses 
200
The customer pet was deleted successfully.


400
Bad Request


404
The Customer pet not found.


delete/api/salesforce/Customers/{clientCustomerNo}/Pet/{clientPetId}
Request samples 
Response samples 
application/json
{
  • "clientCustomerNo": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  • "customerPet": {
    },
  • "warnings": {
    },
  • "statusCode": 200
}
Get Customer Prescriptions
Retrieves customer prescriptions based on the provided customer ID and prescription status.


SecurityAPI Key: Bearer 
Request 
path Parameters
customerid
required
string
REQUIREDUnique ID of the customer


 
 Example:  ACS-123456
rxStatus
required
string
REQUIREDStatus of the prescription


 Enum: "Valid" "WaitingVetApproval" "ClosedOrExpired"  
Responses 
200
Success


400
Bad Request


404
The Customer prescription not found.


get/api/customer/{customerid}/CustomerRx/{rxStatus}
Request samples 
Response samples 
application/json
{
  • "ClientId": "PetSmart",
  • "CustomerId": "ACS-123456",
  • "Data": [
    ]
}