strategy-carriers

Update strategy carrier

Partially updates a strategy carrier by its identifier. The composite key (strategy, carrier) is immutable; delivery_type_codes may be replaced as long as each referenced delivery type exists and is active.

patch/api/v1/strategies/{strategyId}/carriers/{id}

Path parameters

strategyIdstring uuid required
Example:01920000-0000-7000-8000-000000000000

Parent strategy identifier (UUID).

idstring uuid required
Example:01920000-0000-7000-8000-000000000000

Strategy carrier identifier (UUID).

Request body

activeboolean
holidays_openboolean
delivery_type_codesstring[]
delivery_modalitiesstring[]
channel_codesstring[]
metadataobject nullable

Response

Strategy carrier updated.

idstring required
strategy_idstring required
carrier_idstring required
delivery_type_codesstring[] required
activeboolean required
holidays_openboolean required
delivery_modalitiesstring[] required
channel_codesstring[] required
coverage_areaobject nullable required
carrier_activeboolean required
metadataobject nullable required
created_atstring required
updated_atstring required

Changes

Changed in 2 of the 9 revisions of this API.171027

    • added the new optional request property active

      new-optional-request-property

    • added the new optional request property channel_codes

      new-optional-request-property

    • added the new optional request property coverage_area

      new-optional-request-property

    • added the new optional request property delivery_modalities

      new-optional-request-property

    • added the new optional request property delivery_type_codes

      new-optional-request-property

    • added the new optional request property freight_rules

      new-optional-request-property

    • added the new optional request property holidays_hours

      new-optional-request-property

    • added the new optional request property holidays_open

      new-optional-request-property

    • added the new optional request property metadata

      new-optional-request-property

    • added the new optional request property operating_hours

      new-optional-request-property

    • added the required property active to the response with the 200 status

      response-required-property-added

    • added the required property carrier to the response with the 200 status

      response-required-property-added

    • added the required property carrier_active to the response with the 200 status

      response-required-property-added

    • added the required property carrier_id to the response with the 200 status

      response-required-property-added

    • added the required property channel_codes to the response with the 200 status

      response-required-property-added

    • added the required property coverage_area to the response with the 200 status

      response-required-property-added

    • added the required property created_at to the response with the 200 status

      response-required-property-added

    • added the required property delivery_modalities to the response with the 200 status

      response-required-property-added

    • added the required property delivery_type_codes to the response with the 200 status

      response-required-property-added

    • added the required property freight_rules to the response with the 200 status

      response-required-property-added

    • added the required property holidays_hours to the response with the 200 status

      response-required-property-added

    • added the required property holidays_open to the response with the 200 status

      response-required-property-added

    • added the required property id to the response with the 200 status

      response-required-property-added

    • added the required property metadata to the response with the 200 status

      response-required-property-added

    • added the required property operating_hours to the response with the 200 status

      response-required-property-added

    • added the required property strategy_id to the response with the 200 status

      response-required-property-added

    • added the required property updated_at to the response with the 200 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 84194c31ab851710See the full diff
    • removed the required property active from the response with the 200 status

      response-required-property-removed

    • removed the required property carrier from the response with the 200 status

      response-required-property-removed

    • removed the required property carrier_active from the response with the 200 status

      response-required-property-removed

    • removed the required property carrier_id from the response with the 200 status

      response-required-property-removed

    • removed the required property channel_codes from the response with the 200 status

      response-required-property-removed

    • removed the required property coverage_area from the response with the 200 status

      response-required-property-removed

    • removed the required property created_at from the response with the 200 status

      response-required-property-removed

    • removed the required property delivery_modalities from the response with the 200 status

      response-required-property-removed

    • removed the required property delivery_type_codes from the response with the 200 status

      response-required-property-removed

    • removed the required property freight_rules from the response with the 200 status

      response-required-property-removed

    • removed the required property holidays_hours from the response with the 200 status

      response-required-property-removed

    • removed the required property holidays_open from the response with the 200 status

      response-required-property-removed

    • removed the required property id from the response with the 200 status

      response-required-property-removed

    • removed the required property metadata from the response with the 200 status

      response-required-property-removed

    • removed the required property operating_hours from the response with the 200 status

      response-required-property-removed

    • removed the required property strategy_id from the response with the 200 status

      response-required-property-removed

    • removed the required property updated_at from the response with the 200 status

      response-required-property-removed

    • removed the request property active

      request-property-removed

    • removed the request property channel_codes

      request-property-removed

    • removed the request property coverage_area

      request-property-removed

    • removed the request property delivery_modalities

      request-property-removed

    • removed the request property delivery_type_codes

      request-property-removed

    • removed the request property freight_rules

      request-property-removed

    • removed the request property holidays_hours

      request-property-removed

    • removed the request property holidays_open

      request-property-removed

    • removed the request property metadata

      request-property-removed

    • removed the request property operating_hours

      request-property-removed

    This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog