v3 customers changes
In v3, there are a range of improvements and new features with customer operations.
v2 | v3 |
---|---|
Create a customer with POST /v2/Crud/Create/Customer.json . | Create a customer with POST /v3/customers .The request and response field names have changed. Relevant fields are grouped under the contact , billingAddress , and shippingAddress objects.See Customers for more information. |
Read a customer with POST /v2/Crud/Read/Customer.json . | Get customer details with GET /v3/customers/{customerId} . customerId is now set as a path parameter.See Get customer details in the API reference for more information. |
List customers with POST /v2/Crud/List/Customer.json . | Get list of customers with GET /v3/customers .Filtering and sorting values are now query parameters. For filtering, use the filters=field:op:value format . The operator values are now acronyms. For example, = is now eq and >= is now gte .For sorting, use the sort=field:order format. For example, sort by dueDate in the ascending order with sort=dueDate:asc .The response includes nextPage and prevPage values for you to navigate between the pages of results.See Search operations with lists for more information. |
Update a customer with POST /v2/Crud/Update/Customer.json . | Update a customer with PATCH /v3/customers/{customerId} . This is a PATCH operation and customerId is now set as a path parameter.The request and response field names have changed. In your v3 PATCH request, set the customer fields you want to update. All the customer fields are not required in your request. See Update a customer in the API reference for more information. |
Delete a customer with POST /v2/Crud/Delete/Customer.json . | Archive a customer with POST /v3/customers/{customerId}/archive . customerId is now set as a path parameter.In the response, isActive is now archived . The archived field is boolean.See Archive a customer in the API reference for more information. |
Undelete a customer with POST /v2/Crud/Undelete/Customer.json . | Restore a customer with POST /v3/customers/{customerId}/restore . customerId is now set as a path parameter.In the response, isActive is now archived . The archived field is boolean.See Restore an archived customer in the API reference for more information. |
Updated 9 months ago