Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DEVDOCS-6097:[update] add "Aftership" #565

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −5
Open

DEVDOCS-6097:[update] add "Aftership" #565

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions reference/orders.v2.oas2.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -632,9 +632,9 @@ paths:

There are three methods for generating a tracking link for a shipment:

1. Use `shipping_provider` and `tracking_number`: This generates an automatic tracking link that you can click from the BigCommerce control panel and customer-facing emails. The `generated_tracking_link` property in the API response represents this tracking link. The `tracking_link` property in the API response will remain empty.
1. Use `shipping_provider` and `tracking_number`: This generates an automatic Aftership tracking link that you can click from the BigCommerce control panel and customer-facing emails. The `generated_tracking_link` property in the API response represents this tracking link. The `tracking_link` property in the API response will remain empty.

2. Use `tracking_carrier` and `tracking_number`: This also creates an automatic tracking link that you can click in both the BigCommerce control panel and customer-facing emails. Like the previous method, the `generated_tracking_link` property in the API response represents this tracking link. The `tracking_link` property in the API response will remain empty.
2. Use `tracking_carrier` and `tracking_number`: This also creates an automatic Aftership tracking link that you can click in both the BigCommerce control panel and customer-facing emails. Like the previous method, the `generated_tracking_link` property in the API response represents this tracking link. The `tracking_link` property in the API response will remain empty.

3. Supply a custom `tracking_link`: By providing a value for the `tracking_link` property, you can use your own tracking link within the BigCommerce control panel and in customer-facing emails. The API response will return your supplied tracking link as part of the `tracking_link` property in the response. In situations when there isn't a `generated_tracking_link`, the property in the API response will remain empty.

Expand Down Expand Up @@ -3258,7 +3258,7 @@ components:
example: ""
tracking_link:
type: string
description: The custom tracking link supplied on POST or PUT shipments. For the auto-generated tracking link see the `generated_tracking_link` property.
description: The custom tracking link supplied on POST or PUT shipments. For the auto-generated Aftership tracking link see the `generated_tracking_link` property.
comments:
type: string
description: Comments the shipper wishes to add.
Expand Down Expand Up @@ -3289,7 +3289,7 @@ components:
readOnly: true
generated_tracking_link:
type: string
description: The tracking link that is generated using the combination of either the `tracking_number` and `shipping_provider` or `tracking_number` and `tracking_carrier`. This will be empty if the custom `tracking_link` value is provided.
description: The Aftership tracking link that is generated using the combination of either the `tracking_number` and `shipping_provider` or `tracking_number` and `tracking_carrier`. This will be empty if the custom `tracking_link` value is provided.
x-internal: false
orderConsignments_Resource:
title: orderConsignments_Resource
Expand Down Expand Up @@ -3707,7 +3707,7 @@ components:
example: ""
tracking_link:
type: string
description: The custom tracking link supplied on POST or PUT shipments. For the auto-generated tracking link see the `generated_tracking_link` property.
description: The custom tracking link supplied on POST or PUT shipments. For the Aftership auto-generated tracking link see the `generated_tracking_link` property.
example: https://www.mycustomtrackinglink.com/tracking
maxLength: 500
comments:
Expand Down
Loading