HomeGuidesAPI ReferenceRelease Notes
Log In
API Reference

ADM-BUYING-POLICY-203 - Update a grace amount entry

put
https://example.com/v1/buying-policies/credit-control/grace-amounts/

Updates the full content of an existing grace amount entry for a Customer Account.

You may update the amount, startDate, and/or endDate.


⚠️ This endpoint is only accessible when the dj-client header is set to OPERATOR.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
int32
required
date-time | null

The end date of the grace amount. If null, the credit hold is permanent.

date-time
required

The start date of the grace amount.

Headers
string
enum
required

Specifies the client type making the request.

  • OPERATOR: Platform operator user.

  • ACCOUNT: Customer account user.

  • SUPPLIER: Supplier managing orders.

Allowed:
string
required

API key required for authentication. Must be valid and linked to the requesting user.

string

(Optional) Store ID in multi-store environments.

string

(Optional) Store view ID in multi-store environments.

Responses
200

Grace amount entry successfully replaced.

400

Invalid request payload. This error occurs when:

  • Required fields (amount, startDate) are missing or empty
  • amount is negative or improperly formatted
  • Date formats are invalid (must be ISO 8601: YYYY-MM-DDTHH:MM:SSZ)
  • startDate is earlier than creation date
  • endDate is earlier than startDate (if provided)
  • The grace amount entry is in an invalid state for update

    Please verify that all fields are correctly provided and properly formatted.
401

Authentication required.

403

Access forbidden.

404

Grace amount entry not found.

500

Unexpected server error.

Updated 12 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 12 months ago

Did this page help you?