REST v2 - API Documentation Corrections

API Q&A
1

@OmarAlmonte, can you get the REST v2 API Documentation updated for the Create a Contact Endpoint.

https://developer.infusionsoft.com/docs/restv2/#tag/Contact/operation/createContact

It returns a “201” Code, but the documentation says “200”.

Thanks.

2

Hi @Pav, thanks for reporting this. In some cases, this endpoint can return a 200 response when the duplicate option is used.

Upon that said, I’ll update the documentation to reflect this behavior. The changes should be live by the end of next week.

3

The Orders - List Orders endpoint is listing the “invoice_xid” filter parameter, I believe that is a mistake.

https://developer.infusionsoft.com/docs/restv2/#tag/Orders/operation/listOrders

4

Another one to add to the list.

Now we have 2 Endpoints to the retrieve the Payments, can you update the Orders - Retrieve Order Payments endpoint to mention about the Sales - List Payments endpoint as it returns more information.

https://developer.infusionsoft.com/docs/restv2/#tag/Orders/operation/listOrderPayments

https://developer.infusionsoft.com/docs/restv2/#tag/Sales/operation/listPayments

Thanks.

5

Regarding the invoice_xid filter parameter, that one is intentional. invoice_xid is a Keap-generated public UUID for invoices that’s presented to the contact when viewing an invoice (for example, in the invoice URL).

It’s different from:

  • invoice_id → internal system ID primarily intended for API consumers
  • invoice_number → user/business-generated invoice identifier presented to customers

The invoice_xid is intended to be searchable.

For the second point, can you clarify what you’d like updated there? I’m not fully understanding the request.

Are you suggesting we add a note in the Orders - Retrieve Order Payments endpoint documentation pointing users to the Sales - List Payments endpoint because it returns a more complete payment object?

6

It would be a good idea to explain what those fields mean exactly, other developers will think it is some type of typo in there.

When retrieving the payments for the orders, I used the Orders - Retrieve Order Payments, but then I ran into an issue where the Pay Type field was not available. I noticed the new Sales - List Payments has that ability. For developers who are migrating their code across, it would be a good idea to mention the Sales endpoint.

7

https://developer.infusionsoft.com/docs/restv2/#tag/Note/operation/createNote

The “required” wording needs to be removed for the “user_id” field as you can create a note without specifying it.

8

Hi @Pav, the POST contacts documentation is now corrected. I will look into the notes endpoint. Thanks!

9

The Product - List Products endpoint “order_by” query parameter supports ordering by the “id” field.