Configuring pickup cutoffs by using APIs

You can configure a pickup cutoff to schedule a specific time to restrict customer collections. Any pickups that are scheduled after the cutoff are moved to the next available pickup before the cutoff is reached for customer collection.

Before you begin

Ensure that you are familiar with pickup cutoffs. For more information, see Pickup cutoffs.

About this task

The pickup cutoff configuration is optional. Also, you might choose to configure a node cutoff only or to configure both node cutoffs and pickup cutoffs. If you define both cutoffs, ensure that the node cutoff is not scheduled earlier than the pickup cutoff.

Procedure

To create a pickup cutoff, use the Define pick cutoff schedule API.

For example, you can specify a pickup cutoff to start at 16:00 hours from Monday to Sunday, excluding Tuesday when the pickup cutoff is extended to start at 23:59 hours.

[
  {
    "validFromDateIncl": "2000-01-01",
    "validToDateIncl": "2999-12-31",
    "schedule": {
      "monday": "16:00:00",
      "tuesday": "23:59:59",
      "wednesday": "16:00:00",
      "thursday": "16:00:00",
      "friday": "16:00:00",
      "saturday": "16:00:00",
      "sunday": "16:00:00"
    }
  }
]

Any items that are scheduled for pickup after the cutoff is reached are moved to the next available pickup before the next cutoff is reached for customer collection.

What to do next

Depending on your fulfillment requirements, you can define a cutoff with and without a cutoff. For more information, see Scenario: Applying pickup cutoffs.