Logg på

nShift Help Center

Pull API

Avatar
Malene Tidemann
Oppdatert

Seksjoner i denne artikkelen:

 

Offentlig API-autentisering

Returns offentlige API bruker Basic Authentication. Alle metoder som er en del av API-et bruker samme informasjon for autentisering, brukernavn og passord for din organisasjon (bilde som viser brukstilfellet fra Postman nedenfor).

 

returns-authentication.png

 

Endepunkter

Hent liste over retursordre

URL: GET /return-orders

Endepunktet returnerer en liste over retursordre basert på spørringsstrengparametere sendt i metoden.


Parametere:

Parameter Type Påkrevd
updatedAfter DatoTid (ISO-format) Nei
updatedBefore DatoTid (ISO-format) Nei
createdAfter DatoTid (ISO-format) Nei
createdBefore DatoTid (ISO-format) Nei

 

Eksempel på kall:

GET https://staging.returnado.com/public-api/v3/return-orders?updatedAfter=2022-12-20T01:30:00.
000-05:00&updatedBefore=2022-12-31T01:30:00.000-05:00&createdAfter=2022-12-20T01:30:00.000-05:0
0&createdBefore=2022-12-31T01:30:00.000-05:00


Henter alle retursordre oppdatert etter 2022/12/20 og før 2022/12/31 og opprettet etter 2020/12/20 og før 2022/12/31.

 

Respons

ResponseWrapper:

Felt Type Beskrivelse
records ReturnOrder[] Poster funnet ved søk
totalRecords heltall Antall poster funnet

 

{
  "records": [
    {
      "returnOrderId": 56373,
      "returnOrderExtId": "{}",
      "orderId": "249-307",
      "createdAt": "2022-12-20T18:02:31Z",
      "updatedAt": "2022-12-20T18:02:32Z",
      "marketCode": "27001",
      "customerId": "john_doe@nshift.com",
      "status": "pre_approval",
      "currency": "GBP",
      "netOriginalTotal": 1198.8,
      "taxOriginalTotal": 0,
      "grossOriginalTotal": 1198.8,
      "netRefundItemsTotal": 999,
      "taxRefundItemsTotal": 0,
      "grossRefundItemsTotal": 999,
      "netShippingFeeRefund": 0,
      "taxShippingFeeRefund": 0,
      "grossShippingFeeRefund": 0,
      "netFeesTotal": 0,
      "taxFeesTotal": 0,
      "grossFeesTotal": 0,
      "netRefundTotal": 999,
      "taxRefundTotal": 0,
      "grossRefundTotal": 999,
      "items": [
        {
          "returnOrderId": 56373,
          "returnOrderExtId": "{}",
          "returnOrderItemId": 120808,
          "originalOrderItemId": "1",
          "productId": "iris",
          "productVariantId": "iris",
          "originalNetAmount": 999,
          "originalTaxAmount": 0,
          "originalGrossAmount": 999,
          "reportedCondition": "tags_are_intact",
          "reclamationReason": "style_doesnt_suit",
          "nextAction": "restock",
          "status": "pending",
          "refundQuantity": 1,
          "netRefundAmount": 999,
          "taxRefundAmount": 0,
          "grossRefundAmount": 999
        }
      ]
    }
  ],
  "totalRecords": 1
}

 

 

Hent retursordrelinje etter Id

URL: GET /return-orders/{returnOrderId}

Endepunktet returnerer retursordre identifisert av id-en brukt i url-stien.

 

Parametere:

Parameter Type Påkrevd
returnOrderId heltall ja

 

Eksempel på kall:

GET https://staging.returnado.com/public-api/v3/return-orders/56373

Henter retursordre som er identifisert med id 56373.

 

Respons:

ReturnOrder

{
  "returnOrderId": 56373,
  "returnOrderExtId": "{}",
  "orderId": "249-307",
  "createdAt": "2022-12-20T18:02:31Z",
  "updatedAt": "2022-12-20T18:02:32Z",
  "marketCode": "27001",
  "customerId": "john_doe@nshift.com",
  "status": "pre_approval",
  "currency": "GBP",
  "netOriginalTotal": 1198.8,
  "taxOriginalTotal": 0,
  "grossOriginalTotal": 1198.8,
  "netRefundItemsTotal": 999,
  "taxRefundItemsTotal": 0,
  "grossRefundItemsTotal": 999,
  "netShippingFeeRefund": 0,
  "taxShippingFeeRefund": 0,
  "grossShippingFeeRefund": 0,
  "netFeesTotal": 0,
  "taxFeesTotal": 0,
  "grossFeesTotal": 0,
  "netRefundTotal": 999,
  "taxRefundTotal": 0,
  "grossRefundTotal": 999,
  "items": [
    {
      "returnOrderId": 56373,
      "returnOrderExtId": "{}",
      "returnOrderItemId": 120808,
      "originalOrderItemId": "1",
      "productId": "iris",
      "productVariantId": "iris",
      "originalNetAmount": 999,
      "originalTaxAmount": 0,
      "originalGrossAmount": 999,
      "reportedCondition": "tags_are_intact",
      "reclamationReason": "style_doesnt_suit",
      "nextAction": "restock",
      "status": "pending",
      "refundQuantity": 1,
      "netRefundAmount": 999,
      "taxRefundAmount": 0,
      "grossRefundAmount": 999
    }
  ]
}

 

 

Hent returoversikt

URL: GET /returns-summary

Endepunktet returnerer en oversikt over retursordre for kunden som forespør dem. 

Basert på filtrene kan endepunktet brukes til å filtrere kun retursordre for et spesifikt marked (for eksempel kun Sverige-markedet hvis retursordre er logget for både UK og Sverige).

periodStart og periodEnd anvendes på datoen da retursordre sist ble oppdatert.


Denne endepunktet inkluderer også paginering. Paginering starter med side 0.


Parametere:

Parameter Type Påkrevd
periodStart DatoTid (ISO-format) ja
periodEnd DatoTid (ISO-format) nei
marketCode heltall nei
pageSize heltall nei
pageNumber heltall nei

 

Eksempel på kall:

GET https://staging.returnado.com/public-api/v3/returns-summary?periodStart=2022-12-10T01:30:00
.000-05:00&periodEnd=2022-12-31T01:30:00.000-05:00&marketCode=27001&pageSize=5&pageNumber=1

 

Henter ordre som tilhører det identifiserte markedet, oppdatert innenfor nevnte periode. På grunn av paginering vil den hoppe over de første 5 ordrene (sortert etter return_order_item_id)

 

Respons:

Returnerer PaginatedResponse<ReturnSummary>

Felt Type Påkrevd
records ReturnSummary[] Returnoversikter returnert ved søk
totalRecords heltall Antall poster funnet
pagination.totalPages heltall Antall sider som resultatene spenner over i gjeldende pagineringskonfigurasjon
pagination.currentPage heltall Siden som de nåværende hentede dataene tilhører
pagination.currentPageSize heltall Antall returnoversikter per side som API-et for øyeblikket henter

 

{
  "records": [
    {
      "marketCode": "27001",
      "marketName": "Arena-1",
      "customerId": "john_doe_1@gmail.com",
      "orderId": "968-309",
      "returnOrderId": 56367,
      "returnOrderItemId": 120801,
      "productId": "hermes",
      "productVariantId": "hermes",
      "sku": "hermes",
      "productName": "hermes",
      "currencyCode": "GBP",
      "returnedQuantity": 1,
      "returnReasonCode": "style_doesnt_suit",
      "itemConditionCode": "accessory_missing",
      "nextActionCode": "restock",
      "originalValueGross": 579,
      "returnValueGross": 579,
      "reconversionValueGross": 0,
      "refundValueGross": 579,
      "orderCreatedAt": "2022-12-19T10:19:36Z",
      "createdAt": "2022-12-19T10:22:10Z",
      "currentState": "awaiting_approval",
      "stateUpdatedAt": "2022-12-19T10:22:10Z",
      "claim": false,
      "refundApproved": false
    },
    {
      "marketCode": "27001",
      "marketName": "Arena-1",
      "customerId": "john_doe_2@nshift.com",
      "orderId": "819-761",
      "returnOrderId": 56368,
      "returnOrderItemId": 120802,
      "productId": "hera",
      "productVariantId": "hera",
      "sku": "hera",
      "productName": "hera",
      "currencyCode": "GBP",
      "returnedQuantity": 1,
      "returnReasonCode": "colour_not_as_expected",
      "itemConditionCode": "accessory_missing",
      "nextActionCode": "restock",
      "originalValueGross": 39,
      "returnValueGross": 39,
      "reconversionValueGross": 0,
      "refundValueGross": 39,
      "orderCreatedAt": "2022-12-19T14:57:25Z",
      "createdAt": "2022-12-19T14:58:37Z",
      "currentState": "awaiting_approval",
      "stateUpdatedAt": "2022-12-19T14:58:37Z",
      "claim": false,
      "refundApproved": false
    },
    {
      "marketCode": "27001",
      "marketName": "Arena-1",
      "customerId": "john_doe@nshift.com",
      "orderId": "249-307",
      "returnOrderId": 56373,
      "returnOrderItemId": 120808,
      "productId": "iris",
      "productVariantId": "iris",
      "sku": "iris",
      "productName": "iris",
      "currencyCode": "GBP",
      "returnedQuantity": 1,
      "returnReasonCode": "style_doesnt_suit",
      "itemConditionCode": "tags_are_intact",
      "nextActionCode": "restock",
      "originalValueGross": 999,
      "returnValueGross": 999,
      "reconversionValueGross": 0,
      "refundValueGross": 999,
      "orderCreatedAt": "2022-12-20T17:59:56Z",
      "createdAt": "2022-12-20T18:02:31Z",
      "currentState": "awaiting_approval",
      "stateUpdatedAt": "2022-12-20T18:02:32Z",
      "claim": false,
      "refundApproved": false
    }
  ],
  "totalRecords": 8,
  "pagination": {
    "totalPages": 2,
    "currentPage": 1,
    "currentPageSize": 3
  }
}

Endepunktet for ReturnOrderSummary gir også informasjon om tilstanden til ordren, samt refusjonstilstanden.

 

 

Oppdater refusjonsstatus for retursordre

URL: PUT /update-return-status/{returnOrderId}

Dette endepunktet brukes til å oppdatere statusen for retursordre.

 

Parametere:

Felt Type Påkrevd
returnOrderId bool true

 

Request Body:

{
  "refundSucceeded": true,
  "orderId": null,
  "errorCode": "e404",
  "errorDescription": "insufficient funds"
}

 

Parameter Type Påkrevd
refundSucceeded boolean ja
orderId string nei
errorCode string nei
errorDescription string nei

 

Eksempel på kall:

PUT https://staging.returnado.com/public-api/v3/update-return-status/56367

 

Respons:

HTTP 200 hvis forespørselen fullføres uten feil.

Feilkoder der det er relevant:

For eksempel, hvis refundSucceeded mangler

 

{
  "code": 422,
  "error": "Unprocessable Entity",
  "message": "Field error in object 'returnOrderUpdateStatusDto' on field 'refundSucceeded': 
   rejected value [null]; codes [NotNull.returnOrderUpdateStatusDto.refundSucceeded,NotNull.
   refundSucceeded,NotNull.java.lang.Boolean,NotNull]; arguments [org.springframework.context
   .support.DefaultMessageSourceResolvable: codes [returnOrderUpdateStatusDto.refundSucceeded,
   refundSucceeded]; arguments []; default message [refundSucceeded]]; default message [must 
   not be null]",
  "timestamp": "2023-01-16T17:22:05Z"
}

 

Relaterte artikler