Skip to content

Commit b51f0a7

Browse files
authored
Merge pull request #15 from 1415003719/2026-01
update readme
2 parents 19976e2 + 049b4fd commit b51f0a7

1 file changed

Lines changed: 88 additions & 88 deletions

File tree

README.md

Lines changed: 88 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ If you need support using AfterShip products, please contact support@aftership.c
2020
- [Error Handling](#error-handling)
2121
- [Error List](#error-list)
2222
- [Endpoints](#endpoints)
23-
- [/trackings](#trackings)
2423
- [/couriers](#couriers)
2524
- [/courier-connections](#courier-connections)
2625
- [/estimated-delivery-date](#estimated-delivery-date)
26+
- [/trackings](#trackings)
2727
- [Help](#help)
2828
- [License](#license)
2929

@@ -38,7 +38,7 @@ Before you begin to integrate:
3838

3939
### API and SDK Version
4040

41-
- SDK Version:
41+
- SDK Version: 15.0.0
4242
- API Version: 2026-01
4343
## Quick Start
4444

@@ -168,14 +168,6 @@ The SDK will return an error object when there is any error during the request,
168168

169169
The AfterShip SDK has the following resource which are exactly the same as the API endpoints:
170170

171-
- TrackingResource
172-
- Get trackings
173-
- Create a tracking
174-
- Get a tracking by ID
175-
- Update a tracking by ID
176-
- Delete a tracking by ID
177-
- Retrack an expired tracking by ID
178-
- Mark tracking as completed by ID
179171
- CourierResource
180172
- Get couriers
181173
- Detect courier
@@ -188,207 +180,215 @@ The AfterShip SDK has the following resource which are exactly the same as the A
188180
- EstimatedDeliveryDateResource
189181
- Prediction for the Estimated Delivery Date
190182
- Batch prediction for the Estimated Delivery Date
183+
- TrackingResource
184+
- Get trackings
185+
- Create a tracking
186+
- Get a tracking by ID
187+
- Update a tracking by ID
188+
- Delete a tracking by ID
189+
- Retrack an expired tracking by ID
190+
- Mark tracking as completed by ID
191191

192-
### /trackings
193-
**GET** /trackings
192+
### /couriers
193+
**GET** /couriers
194194

195195
```csharp
196-
GetTrackingsOptions options = new GetTrackingsOptions();
197-
GetTrackingsResponse response = client.Tracking.GetTrackings(options);
196+
GetCouriersOptions options = new GetCouriersOptions();
197+
GetCouriersResponse response = client.Courier.GetCouriers(options);
198198
if (response != null)
199199
{
200200
Console.WriteLine(response);
201201
}
202202
```
203203

204-
**POST** /trackings
204+
**POST** /couriers/detect
205205

206206
```csharp
207-
CreateTrackingOptions options = new CreateTrackingOptions();
208-
CreateTrackingRequest createTrackingRequest = new CreateTrackingRequest();
209-
createTrackingRequest.TrackingNumber = "valid_value";
210-
options.CreateTrackingRequest = createTrackingRequest;
211-
CreateTrackingResponse response = client.Tracking.CreateTracking(options);
207+
DetectCourierOptions options = new DetectCourierOptions();
208+
DetectCourierRequest detectCourierRequest = new DetectCourierRequest();
209+
detectCourierRequest.TrackingNumber = "valid_value";
210+
options.DetectCourierRequest = detectCourierRequest;
211+
DetectCourierResponse response = client.Courier.DetectCourier(options);
212212
if (response != null)
213213
{
214214
Console.WriteLine(response);
215215
}
216216
```
217217

218-
**GET** /trackings/{id}
218+
### /courier-connections
219+
**GET** /courier-connections
219220

220221
```csharp
221-
GetTrackingByIdOptions options = new GetTrackingByIdOptions();
222-
GetTrackingByIdResponse response = client.Tracking.GetTrackingById("valid_value",options);
222+
GetCourierConnectionsOptions options = new GetCourierConnectionsOptions();
223+
GetCourierConnectionsResponse response = client.CourierConnection.GetCourierConnections(options);
223224
if (response != null)
224225
{
225226
Console.WriteLine(response);
226227
}
227228
```
228229

229-
**PUT** /trackings/{id}
230+
**POST** /courier-connections
230231

231232
```csharp
232-
UpdateTrackingByIdOptions options = new UpdateTrackingByIdOptions();
233-
UpdateTrackingByIdRequest updateTrackingByIdRequest = new UpdateTrackingByIdRequest();
234-
options.UpdateTrackingByIdRequest = updateTrackingByIdRequest;
235-
UpdateTrackingByIdResponse response = client.Tracking.UpdateTrackingById("valid_value",options);
233+
PostCourierConnectionsOptions options = new PostCourierConnectionsOptions();
234+
PostCourierConnectionsRequest postCourierConnectionsRequest = new PostCourierConnectionsRequest();
235+
postCourierConnectionsRequest.CourierSlug = "valid_value";
236+
postCourierConnectionsRequest.Credentials = new Dictionary<string, string>();
237+
options.PostCourierConnectionsRequest = postCourierConnectionsRequest;
238+
PostCourierConnectionsResponse response = client.CourierConnection.PostCourierConnections(options);
236239
if (response != null)
237240
{
238241
Console.WriteLine(response);
239242
}
240243
```
241244

242-
**DELETE** /trackings/{id}
245+
**GET** /courier-connections/{id}
243246

244247
```csharp
245-
DeleteTrackingByIdOptions options = new DeleteTrackingByIdOptions();
246-
DeleteTrackingByIdResponse response = client.Tracking.DeleteTrackingById("valid_value",options);
248+
GetCourierConnectionsByIdOptions options = new GetCourierConnectionsByIdOptions();
249+
GetCourierConnectionsByIdResponse response = client.CourierConnection.GetCourierConnectionsById("valid_value",options);
247250
if (response != null)
248251
{
249252
Console.WriteLine(response);
250253
}
251254
```
252255

253-
**POST** /trackings/{id}/retrack
256+
**PATCH** /courier-connections/{id}
254257

255258
```csharp
256-
RetrackTrackingByIdOptions options = new RetrackTrackingByIdOptions();
257-
RetrackTrackingByIdResponse response = client.Tracking.RetrackTrackingById("valid_value",options);
259+
PutCourierConnectionsByIdOptions options = new PutCourierConnectionsByIdOptions();
260+
PutCourierConnectionsByIdRequest putCourierConnectionsByIdRequest = new PutCourierConnectionsByIdRequest();
261+
putCourierConnectionsByIdRequest.Credentials = new Dictionary<string, string>();
262+
options.PutCourierConnectionsByIdRequest = putCourierConnectionsByIdRequest;
263+
PutCourierConnectionsByIdResponse response = client.CourierConnection.PutCourierConnectionsById("valid_value",options);
258264
if (response != null)
259265
{
260266
Console.WriteLine(response);
261267
}
262268
```
263269

264-
**POST** /trackings/{id}/mark-as-completed
270+
**DELETE** /courier-connections/{id}
265271

266272
```csharp
267-
MarkTrackingCompletedByIdOptions options = new MarkTrackingCompletedByIdOptions();
268-
MarkTrackingCompletedByIdRequest markTrackingCompletedByIdRequest = new MarkTrackingCompletedByIdRequest();
269-
options.MarkTrackingCompletedByIdRequest = markTrackingCompletedByIdRequest;
270-
MarkTrackingCompletedByIdResponse response = client.Tracking.MarkTrackingCompletedById("valid_value",options);
273+
DeleteCourierConnectionsByIdOptions options = new DeleteCourierConnectionsByIdOptions();
274+
DeleteCourierConnectionsByIdResponse response = client.CourierConnection.DeleteCourierConnectionsById("valid_value",options);
271275
if (response != null)
272276
{
273277
Console.WriteLine(response);
274278
}
275279
```
276280

277-
### /couriers
278-
**GET** /couriers
281+
### /estimated-delivery-date
282+
**POST** /estimated-delivery-date/predict
279283

280284
```csharp
281-
GetCouriersOptions options = new GetCouriersOptions();
282-
GetCouriersResponse response = client.Courier.GetCouriers(options);
285+
PredictOptions options = new PredictOptions();
286+
EstimatedDeliveryDateRequest predictRequest = new EstimatedDeliveryDateRequest();
287+
predictRequest.Slug = "valid_value";
288+
EstimatedDeliveryDateRequestOriginAddress originAddress = new EstimatedDeliveryDateRequestOriginAddress();
289+
predictRequest.OriginAddress = originAddress;
290+
EstimatedDeliveryDateRequestDestinationAddress destinationAddress = new EstimatedDeliveryDateRequestDestinationAddress();
291+
predictRequest.DestinationAddress = destinationAddress;
292+
options.PredictRequest = predictRequest;
293+
PredictResponse response = client.EstimatedDeliveryDate.Predict(options);
283294
if (response != null)
284295
{
285296
Console.WriteLine(response);
286297
}
287298
```
288299

289-
**POST** /couriers/detect
300+
**POST** /estimated-delivery-date/predict-batch
290301

291302
```csharp
292-
DetectCourierOptions options = new DetectCourierOptions();
293-
DetectCourierRequest detectCourierRequest = new DetectCourierRequest();
294-
detectCourierRequest.TrackingNumber = "valid_value";
295-
options.DetectCourierRequest = detectCourierRequest;
296-
DetectCourierResponse response = client.Courier.DetectCourier(options);
303+
PredictBatchOptions options = new PredictBatchOptions();
304+
PredictBatchRequest predictBatchRequest = new PredictBatchRequest();
305+
options.PredictBatchRequest = predictBatchRequest;
306+
PredictBatchResponse response = client.EstimatedDeliveryDate.PredictBatch(options);
297307
if (response != null)
298308
{
299309
Console.WriteLine(response);
300310
}
301311
```
302312

303-
### /courier-connections
304-
**GET** /courier-connections
313+
### /trackings
314+
**GET** /trackings
305315

306316
```csharp
307-
GetCourierConnectionsOptions options = new GetCourierConnectionsOptions();
308-
GetCourierConnectionsResponse response = client.CourierConnection.GetCourierConnections(options);
317+
GetTrackingsOptions options = new GetTrackingsOptions();
318+
GetTrackingsResponse response = client.Tracking.GetTrackings(options);
309319
if (response != null)
310320
{
311321
Console.WriteLine(response);
312322
}
313323
```
314324

315-
**POST** /courier-connections
325+
**POST** /trackings
316326

317327
```csharp
318-
PostCourierConnectionsOptions options = new PostCourierConnectionsOptions();
319-
PostCourierConnectionsRequest postCourierConnectionsRequest = new PostCourierConnectionsRequest();
320-
postCourierConnectionsRequest.CourierSlug = "valid_value";
321-
postCourierConnectionsRequest.Credentials = new Dictionary<string, string>();
322-
options.PostCourierConnectionsRequest = postCourierConnectionsRequest;
323-
PostCourierConnectionsResponse response = client.CourierConnection.PostCourierConnections(options);
328+
CreateTrackingOptions options = new CreateTrackingOptions();
329+
CreateTrackingRequest createTrackingRequest = new CreateTrackingRequest();
330+
createTrackingRequest.TrackingNumber = "valid_value";
331+
options.CreateTrackingRequest = createTrackingRequest;
332+
CreateTrackingResponse response = client.Tracking.CreateTracking(options);
324333
if (response != null)
325334
{
326335
Console.WriteLine(response);
327336
}
328337
```
329338

330-
**GET** /courier-connections/{id}
339+
**GET** /trackings/{id}
331340

332341
```csharp
333-
GetCourierConnectionsByIdOptions options = new GetCourierConnectionsByIdOptions();
334-
GetCourierConnectionsByIdResponse response = client.CourierConnection.GetCourierConnectionsById("valid_value",options);
342+
GetTrackingByIdOptions options = new GetTrackingByIdOptions();
343+
GetTrackingByIdResponse response = client.Tracking.GetTrackingById("valid_value",options);
335344
if (response != null)
336345
{
337346
Console.WriteLine(response);
338347
}
339348
```
340349

341-
**PATCH** /courier-connections/{id}
350+
**PUT** /trackings/{id}
342351

343352
```csharp
344-
PutCourierConnectionsByIdOptions options = new PutCourierConnectionsByIdOptions();
345-
PutCourierConnectionsByIdRequest putCourierConnectionsByIdRequest = new PutCourierConnectionsByIdRequest();
346-
putCourierConnectionsByIdRequest.Credentials = new Dictionary<string, string>();
347-
options.PutCourierConnectionsByIdRequest = putCourierConnectionsByIdRequest;
348-
PutCourierConnectionsByIdResponse response = client.CourierConnection.PutCourierConnectionsById("valid_value",options);
353+
UpdateTrackingByIdOptions options = new UpdateTrackingByIdOptions();
354+
UpdateTrackingByIdRequest updateTrackingByIdRequest = new UpdateTrackingByIdRequest();
355+
options.UpdateTrackingByIdRequest = updateTrackingByIdRequest;
356+
UpdateTrackingByIdResponse response = client.Tracking.UpdateTrackingById("valid_value",options);
349357
if (response != null)
350358
{
351359
Console.WriteLine(response);
352360
}
353361
```
354362

355-
**DELETE** /courier-connections/{id}
363+
**DELETE** /trackings/{id}
356364

357365
```csharp
358-
DeleteCourierConnectionsByIdOptions options = new DeleteCourierConnectionsByIdOptions();
359-
DeleteCourierConnectionsByIdResponse response = client.CourierConnection.DeleteCourierConnectionsById("valid_value",options);
366+
DeleteTrackingByIdOptions options = new DeleteTrackingByIdOptions();
367+
DeleteTrackingByIdResponse response = client.Tracking.DeleteTrackingById("valid_value",options);
360368
if (response != null)
361369
{
362370
Console.WriteLine(response);
363371
}
364372
```
365373

366-
### /estimated-delivery-date
367-
**POST** /estimated-delivery-date/predict
374+
**POST** /trackings/{id}/retrack
368375

369376
```csharp
370-
PredictOptions options = new PredictOptions();
371-
EstimatedDeliveryDateRequest predictRequest = new EstimatedDeliveryDateRequest();
372-
predictRequest.Slug = "valid_value";
373-
EstimatedDeliveryDateRequestOriginAddress originAddress = new EstimatedDeliveryDateRequestOriginAddress();
374-
predictRequest.OriginAddress = originAddress;
375-
EstimatedDeliveryDateRequestDestinationAddress destinationAddress = new EstimatedDeliveryDateRequestDestinationAddress();
376-
predictRequest.DestinationAddress = destinationAddress;
377-
options.PredictRequest = predictRequest;
378-
PredictResponse response = client.EstimatedDeliveryDate.Predict(options);
377+
RetrackTrackingByIdOptions options = new RetrackTrackingByIdOptions();
378+
RetrackTrackingByIdResponse response = client.Tracking.RetrackTrackingById("valid_value",options);
379379
if (response != null)
380380
{
381381
Console.WriteLine(response);
382382
}
383383
```
384384

385-
**POST** /estimated-delivery-date/predict-batch
385+
**POST** /trackings/{id}/mark-as-completed
386386

387387
```csharp
388-
PredictBatchOptions options = new PredictBatchOptions();
389-
PredictBatchRequest predictBatchRequest = new PredictBatchRequest();
390-
options.PredictBatchRequest = predictBatchRequest;
391-
PredictBatchResponse response = client.EstimatedDeliveryDate.PredictBatch(options);
388+
MarkTrackingCompletedByIdOptions options = new MarkTrackingCompletedByIdOptions();
389+
MarkTrackingCompletedByIdRequest markTrackingCompletedByIdRequest = new MarkTrackingCompletedByIdRequest();
390+
options.MarkTrackingCompletedByIdRequest = markTrackingCompletedByIdRequest;
391+
MarkTrackingCompletedByIdResponse response = client.Tracking.MarkTrackingCompletedById("valid_value",options);
392392
if (response != null)
393393
{
394394
Console.WriteLine(response);

0 commit comments

Comments
 (0)