Use this collection to integrate partner systems with JustFoodForDogs customer, pet, veterinarian, pet-snapshot, and registration-workflow resources.
\nThis collection is distributed with two Postman environments:
\nPartner API Sandbox — use for development, integration testing, and validation.
\nPartner API Production — use only for live partner traffic after approval.
\nSelect the appropriate environment in Postman before sending any request. Each environment defines the following variables:
\nObtain environment-specific values from your JustFoodForDogs integration contact. Do not commit credentials to source control or expose them in exported collections, screenshots, logs, or support messages.
\nThe collection-level pre-request script reads credentials from the selected environment and adds these headers automatically:
\nAll request URLs use {{baseUrl}} from the active environment.
Import or fork the collection and both supplied environments into a private workspace.
\nSelect Partner API Sandbox in Postman's environment selector.
\nPopulate baseUrl, clientId, clientSecret, and partnerId with the sandbox values supplied to your organization.
Send a non-destructive request or an agreed test workflow to validate connectivity.
\nSwitch to Partner API Production only after sandbox validation and production approval.
\nPopulate the Production environment with production-specific values; do not reuse sandbox credentials or URLs.
\nConfirm the active environment before every write or delete operation.
\nA partner owns customer records through its partner scope.
\nA customer can have one or more pets.
\nA pet can have multiple point-in-time profile and nutrition snapshots.
\nVeterinarian records can be associated with customers and pets.
\nexternalId is the stable customer identifier supplied by your system and is the customer identifier used by all customer-scoped endpoints.
Customers are not addressed by a separate JustFoodForDogs customer ID.
\npetId is the JustFoodForDogs pet identifier returned by pet creation and listing operations.
For a single-call onboarding flow, use Workflows → Pet Registration to create or match the customer, always create a new pet, and optionally record an initial snapshot.
\nFor resource-by-resource integration:
\nCreate, read, or update a customer using the partner-owned externalId.
Create or list pets using that customer's externalId.
Read or update a pet using its petId.
Create pet snapshots as profile or feeding information changes.
\nList snapshots to retrieve the pet's history.
\nCreate or update veterinarian records and associate them with the appropriate customer or pets.
\nRequest bodies are JSON.
\nReplace all example personal data before sending a request.
\nKeep externalId stable and unique within your partner account.
External customer IDs must be URL-safe because they are used in request paths.
\nThe collection generates a new X-Request-ID for every send. Retain it when contacting support.
Confirm the active environment and resource IDs before update or delete operations.
\nNever place sandbox credentials in the Production environment or production credentials in the Sandbox environment.
\nThis collection does not yet include saved response examples or a formal error schema. Inspect each live response's HTTP status and JSON body. When escalating an issue, include the request method and path, timestamp, selected environment, HTTP status, and X-Request-ID; never include clientSecret.
Use the onboarding or support channel provided by your JustFoodForDogs integration contact.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"30939530","collectionId":"ef6e6112-53a4-4510-a8bc-080a88f180a2","publishedId":"2sBY4VLxcr","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-10-05T21:31:13.000Z"},"item":[{"name":"Customers","item":[{"name":"Create a customer","id":"09cf3426-6044-4c53-a2a1-da7bbeac8307","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"externalId\": \"1234abcd\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"address1\": \"123 Main St\",\n \"address2\": \"Apt 3C\",\n \"city\": \"New York\",\n \"stateCode\": \"NY\",\n \"postalCode\": \"10001\",\n \"countryCode\": \"US\",\n \"emailPrimary\": \"janedoe@example.com\",\n \"emailSecondary\": \"janedoe2@example.com\",\n \"phoneMobile\": \"000-000-0000\",\n \"phoneHome\": \"000-000-0000\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/customers","description":"Creates a partner-scoped customer using the stable externalId supplied by your system. Reusing an existing externalId updates the matching customer rather than creating a duplicate.
Retrieves a customer by the partner-owned external customer identifier.
\nPath parameter
\nexternalCustomerId — Stable customer identifier supplied by your system. It must be URL-safe.Updates an existing customer identified by the partner-owned external customer identifier. Include only the fields that should change.
\nPath parameter
\nexternalCustomerId — Stable customer identifier supplied by your system. It must be URL-safe.Lists customers in the authenticated partner scope.
\nQuery parameters
\nlimit — Maximum number of customers to return. Defaults to 50.offset — Number of customers to skip before returning results. Defaults to 0.Maximum number of customers to return. Defaults to 50.
\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"Number of customers to skip before returning results. Defaults to 0.
\n","type":"text/plain"},"key":"offset","value":"0"}],"variable":[]}},"response":[],"_postman_id":"8a8c3956-07c2-405d-9360-d04cf84d97eb"}],"id":"0dc0d727-a36f-4a1c-bb9e-e4b1f28d5686","description":"Create, retrieve, update, and list partner-scoped customers. Customers are fully identified by the stable externalId owned by your system; no separate internal customer ID is used by customer endpoints.
Creates a pet for a customer identified by the partner-owned external customer identifier.
\nPath parameter
\nexternalCustomerId — Stable customer identifier supplied by your system. It must be URL-safe.Retrieves a pet by its JustFoodForDogs pet identifier.
\nPath parameter
\npetId — JustFoodForDogs pet identifier returned by pet creation or listing operations.Optional query parameter
\ninclude — Requests additional related data alongside the pet. Supported value: latestSnapshot, which embeds the pet's most recent profile and nutrition snapshot. Omit to return the pet record alone.Optional. Requests additional related data alongside the pet. Supported value: latestSnapshot — embeds the pet's most recent profile and nutrition snapshot. Omit to return the pet record alone.
Updates an existing pet. Include only the fields that should change.
\nPath parameter
\npetId — JustFoodForDogs pet identifier returned by pet creation or listing operations.Deletes a pet identified by its JustFoodForDogs pet identifier. Confirm the active environment and identifier before sending this request.
\nPath parameter
\npetId — JustFoodForDogs pet identifier returned by pet creation or listing operations.Lists pets belonging to a customer.
\nPath parameter
\nexternalCustomerId — Stable customer identifier supplied by your system. It must be URL-safe.Query parameters
\nlimit — Maximum number of pets to return. Defaults to 50.
offset — Number of pets to skip before returning results. Defaults to 0.
include — Requests additional related data alongside each pet. Supported value: latestSnapshot, which embeds each pet's most recent profile and nutrition snapshot. Omit to return pet records alone.
Maximum number of pets to return. Defaults to 50.
\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"Number of pets to skip before returning results. Defaults to 0.
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"Optional. Requests additional related data alongside each pet. Supported value: latestSnapshot — embeds each pet's most recent profile and nutrition snapshot. Omit to return pet records alone.
Create and manage pets belonging to partner-scoped customers. Creating and listing pets uses the customer's partner-owned externalId as externalCustomerId; reading, updating, and deleting an individual pet uses its JustFoodForDogs petId.
Creates a point-in-time profile and nutrition snapshot for a pet.
\nPath parameter
\npetId — JustFoodForDogs pet identifier returned by pet creation or listing operations.Lists saved profile and nutrition snapshots for a pet. Snapshots are returned newest first; use limit=1&offset=0 to retrieve only the latest assessment.
Path parameter
\npetId — JustFoodForDogs pet identifier returned by pet creation or listing operations.Query parameters
\nlimit — Maximum number of snapshots to return. Defaults to 50.offset — Number of snapshots to skip before returning results. Defaults to 0.Maximum number of snapshots to return. Defaults to 50. Use 1 to retrieve only the latest assessment.
\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"Number of snapshots to skip before returning results. Defaults to 0.
\n","type":"text/plain"},"key":"offset","value":"0"}],"variable":[{"type":"any","key":"petId"}]}},"response":[],"_postman_id":"5ffaeffc-369b-4e31-ac24-f3c999393b0e"}],"id":"754d13bc-9132-452c-8fb4-56c4fe5ac4c9","description":"Create and list point-in-time pet profile and nutrition snapshots. Snapshots capture attributes such as weight, body type, diet, health goals, food selection, portion selection, and daily calorie requirements. List results are returned newest first.
\n","_postman_id":"754d13bc-9132-452c-8fb4-56c4fe5ac4c9"},{"name":"Workflows","item":[{"name":"Pet Registration","id":"2a551f58-4204-4ccd-af15-778e1aa4edab","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"externalId\": \"1234abcd\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"emailPrimary\": \"janedoe@example.com\",\n \"phoneMobile\": \"000-000-0000\"\n },\n \"pet\": {\n \"name\": \"Stella\",\n \"gender\": \"female\",\n \"birthMonth\": 8,\n \"birthYear\": 2009,\n \"breed\": \"Mixed\"\n },\n \"snapshot\": {\n \"sterilized\": true,\n \"weight\": 18,\n \"bodyType\": \"Just Right\",\n \"currentlyEats\": \"Fresh Frozen\",\n \"healthGoal\": \"Maintain Weight\",\n \"allergies\": \"None\",\n \"treats\": \"Some\",\n \"foodSelection\": \"JustFresh\",\n \"portionSelection\": \"Standard\",\n \"caloriesRequiredPerDay\": 1000\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/workflows/pet-registration","description":"Creates or matches a customer, always creates a new pet, and optionally records an initial profile and nutrition snapshot in one partner-scoped request. Use the stable customer externalId supplied by your system. Reusing an externalId can match the existing customer, but it never updates or reuses an existing pet.
Business-level integration workflows that coordinate multiple JustFoodForDogs resources in a single request.
\nUse these operations when a partner action spans more than one resource and would otherwise require several individual API calls. For example, Pet Registration creates or matches the customer, always creates a new pet, and optionally records an initial profile and nutrition snapshot.
\nWorkflow requests remain scoped to the authenticated partner. Use stable partner-owned identifiers, send the complete current data expected by each workflow, and retain the generated X-Request-ID for troubleshooting.
Creates a veterinarian record and associates it with a customer and one or more pets in the same request. customerExternalId identifies the partner-owned customer, and each entry in petIds is a JustFoodForDogs pet identifier.
Retrieves a veterinarian by its JustFoodForDogs vet identifier.
\nPath parameter
\nvetId — JustFoodForDogs veterinarian identifier returned by vet creation or listing operations.Updates an existing veterinarian. Include only the fields that should change.
\nPath parameter
\nvetId — JustFoodForDogs veterinarian identifier returned by vet creation or listing operations.Associates an existing veterinarian with a pet. Supply the veterinarian identifier in the JSON request body.
\nPath parameter
\npetId — JustFoodForDogs pet identifier returned by pet creation or listing operations.Removes the association between a veterinarian and a pet. Both identifiers are supplied in the request path.
\nPath parameters
\npetId — JustFoodForDogs pet identifier returned by pet creation or listing operations.vetId — JustFoodForDogs veterinarian identifier returned by vet creation or listing operations.Lists veterinarians associated with a customer.
\nPath parameter
\nexternalCustomerId — Stable customer identifier supplied by your system. It must be URL-safe.Optional query parameters
\nlimit — Maximum number of veterinarians to return. Disabled by default.offset — Number of veterinarians to skip before returning results. Disabled by default.Maximum number of veterinarians to return.
\n","type":"text/plain"},"key":"limit","value":"50"},{"disabled":true,"description":{"content":"Number of veterinarians to skip before returning results.
\n","type":"text/plain"},"key":"offset","value":"0"}],"variable":[{"type":"any","key":"externalCustomerId"}]}},"response":[],"_postman_id":"f69ddf19-b96f-44b2-b0cc-7f2b65cbdceb"},{"name":"List a Pet's Vets","id":"db7e5bbf-8231-4cb3-a77f-fd1c58d8ec0a","request":{"method":"GET","header":[],"url":"{{baseUrl}}/v1/pets/:petId/vets?limit=50&offset=0","description":"Lists veterinarians associated with a pet.
\nPath parameter
\npetId — JustFoodForDogs pet identifier returned by pet creation or listing operations.Optional query parameters
\nlimit — Maximum number of veterinarians to return. Disabled by default.offset — Number of veterinarians to skip before returning results. Disabled by default.Maximum number of veterinarians to return.
\n","type":"text/plain"},"key":"limit","value":"50"},{"disabled":true,"description":{"content":"Number of veterinarians to skip before returning results.
\n","type":"text/plain"},"key":"offset","value":"0"}],"variable":[{"type":"any","key":"petId"}]}},"response":[],"_postman_id":"db7e5bbf-8231-4cb3-a77f-fd1c58d8ec0a"}],"id":"5fcb92c3-9930-41fa-83dd-f366a6583e96","description":"Create and manage veterinarian records and their associations with partner-scoped customers and pets. Vet records use a JustFoodForDogs vetId; customer-scoped operations use the partner-owned externalCustomerId, and pet-scoped operations use petId.
Lists products in the JustFoodForDogs catalog available to the authenticated partner.
\nQuery parameters
\nlimit — Maximum number of products to return. Defaults to 50.offset — Number of products to skip before returning results. Defaults to 0.Response
\nReturns a JSON array of product objects. Each product includes:
\nsku — JustFoodForDogs product identifier.
upc — Universal Product Code.
name — Product display name, including size and pack count where applicable.
partnerSku — Partner-specific product identifier, or null when none is assigned.
productCategory — Product line, for example Daily Diets or Vet Support Diets.
productSubCategory — Recipe or formulation within the product category.
price — Product price as a decimal number.
manufacturer — Product manufacturer.
storageTemp — Required storage temperature, such as Ambient or Frozen.
Maximum number of products to return. Defaults to 50.
\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"Number of products to skip before returning results. Defaults to 0.
\n","type":"text/plain"},"key":"offset","value":"0"}],"variable":[]}},"response":[],"_postman_id":"ae02c9a5-2b4c-4c30-8bc3-5cf101062932"}],"id":"e2ad1b11-fde0-46de-9e78-a11f2b860d90","description":"Retrieve the JustFoodForDogs product catalog available to the authenticated partner. Products are identified by their JustFoodForDogs sku; each product also includes its upc, an optional partner-specific partnerSku, category and subcategory, price, manufacturer, and storage temperature.
Places an order for JustFoodForDogs products on behalf of one of your partner-scoped customers. A successful request returns 202 Accepted with the salesOrderId JustFoodForDogs assigns to the order. The salesOrderId is final; store it immediately and quote it to support. The order itself is created moments after the call returns.
Order rules
\nOrder from your catalog. Every lineItems[].sku must be a sku returned by Products → List Products for your credentials. A SKU outside your catalog rejects the whole order with 400 naming the line. An order is never partly accepted.
orderNumber is the key. It must be unique across every order you send and is never reused. Sending a different order with an orderNumber you have already used returns 409.
Retries are safe. If a call times out, resend the identical request with the same X-Request-ID to receive the original result without creating a second order. The collection generates a new X-Request-ID on every send, so set a fixed value when testing a retry.
The customer is resolved for you. If you send customer.externalId, the order is linked to that customer, matched or created as Customers → Create a customer would. If you omit it, the order is accepted but not linked to a customer record. Contact details on the order do not update the customer record; use Customers → Update a Customer for that.
US only at launch. Addresses must be in the US and amounts must be in USD.
\nStrict validation. Any field not listed below is rejected with 400 naming the field.
Request body
\nCustomer
\nAddress (shipTo and billTo)
Totals
\nAll amounts are zero or greater, with at most two decimal places.
\nLine item
\nDiscount
\nResponses
\n202 Accepted — The order was validated and accepted for processing. Returns salesOrderId (JustFoodForDogs order identifier, final) and orderNumber (echoed). A replayed request returns the same body.
400 — Validation failed: a missing or badly formatted field, an unknown field, or a SKU not in your catalog.
401 — Credentials missing or not recognized.
403 — Credentials are valid but don't match X-Partner-ID.
409 — orderNumber has already been used for a different order (duplicate_order). Nothing was written.
429 — Request rate agreed in your contract exceeded.
500 — Server error. Safe to retry with the same X-Request-ID.
Errors return a consistent envelope with error.code, error.message, error.field, and error.requestId.
Place orders for JustFoodForDogs products on behalf of partner-scoped customers. Orders use sku values from your product catalog (Products → List Products) and are keyed by your partner-owned orderNumber, which must be unique and is never reused. Each accepted order returns a JustFoodForDogs salesOrderId; store it and quote it to support. Reading an order back, checking its status or tracking, and cancelling or amending an order are not available in v1.