Aanmelden

nShift Help Center

Agenten

Avatar
Malene Tidemann
Bijgewerkt

Delivery-checkout-label.png


Maakt en activeert aangepaste agentenlijsten.


Secties in dit artikel:

 

Een agentenlijst aanmaken

POST /agents

Maakt een aangepaste agentenlijst op basis van geolocatie of postcodebereik.

  • Als de agentenlijst onmiddellijk geactiveerd moet worden, moet activate worden ingesteld op true.
     
  • type moet worden ingesteld op normal voor geolocatie en zipcode voor postcodebereik.
     
  • Als normal, zijn mapLongitude en mapLatitude vereist.
     
  • Als zipcode, is een agentZipcodes-array voor elke agent vereist.
     
  • countryCode is altijd vereist.
     

 

Body-voorbeeld – geolocatie

{
  "key": "listkey",
  "activate": "true",
  "type": "normal",
  "countryCode": "SE",
  "agents": [
    {
      "id": "1",
      "name": "Agent name 1",
      "address1": "Test gatan 1",
      "address2": "",
      "zipcode": "41118",
      "city": "Göteborg",
      "state": "",
      "countryCode": "SE",
      "mapLongitude": "22.2",
      "mapLatitude": "-11.1",
      "phone": "07443332211",
      "email": "test@test.com",
      "additionalInfo": "Additional information",
      "flags": [
        "express",
        "hem"
      ],
      "openingHourWeekdays": [
        {
          "weekday": "monday",
          "hours": [
            {
              "start": "08:00",
              "stop": "22:00"
            }
          ]
        },
        {
          "weekday": "tuesday",
          "hours": [
            {
              "start": "08:00",
              "stop": "22:00"
            }
          ]
        },
        {
          "weekday": "wednesday",
          "hours": [
            {
              "start": "08:00",
              "stop": "22:00"
            }
          ]
        },
        {
          "weekday": "thursday",
          "hours": [
            {
              "start": "08:00",
              "stop": "22:00"
            }
          ]
        },
        {
          "weekday": "friday",
          "hours": [
            {
              "start": "08:00",
              "stop": "22:00"
            }
          ]
        },
        {
          "weekday": "saturday",
          "hours": [
            {
              "start": "08:00",
              "stop": "22:00"
            }
          ]
        },
        {
          "weekday": "sunday",
          "hours": [
            {
              "start": "08:00",
              "stop": "22:00"
            }
          ]
        }
      ],
      "openingHourSpecialDays": [
        {
          "date": "2018-04-27",
          "hours": [
            {
              "start": "10:00",
              "stop": "16:00"
            }
          ]
        },
        {
          "date": "2018-04-28",
          "hours": [
            {
              "start": "10:00",
              "stop": "16:00"
            }
          ]
        },
        {
          "date": "2018-10-10",
          "hours": [
            {
              "start": "10:00",
              "stop": "16:00"
            }
          ]
        }
      ]
    },
    {
      "id": "2",
      "name": "Agent name 2",
      "address1": "Testvägen 10",
      "address2": "",
      "zipcode": "11359",
      "city": "Stockholm",
      "state": "",
      "countryCode": "SE",
      "mapLongitude": "33.3",
      "mapLatitude": "17.4",
      "phone": "0700331122",
      "email": "test2@test2.com",
      "additionalInfo": "Additional information",
      "flags": [
        "hem"
      ],
      "openingHourWeekdays": [
        {
          "weekday": "monday",
          "hours": [
            {
              "start": "10:00",
              "stop": "23:00"
            }
          ]
        },
        {
          "weekday": "tuesday",
          "hours": [
            {
              "start": "10:00",
              "stop": "23:00"
            }
          ]
        },
        {
          "weekday": "wednesday",
          "hours": [
            {
              "start": "10:00",
              "stop": "23:00"
            }
          ]
        },
        {
          "weekday": "thursday",
          "hours": [
            {
              "start": "10:00",
              "stop": "23:00"
            }
          ]
        },
        {
          "weekday": "friday",
          "hours": [
            {
              "start": "10:00",
              "stop": "23:00"
            }
          ]
        },
        {
          "weekday": "saturday",
          "hours": [
            {
              "start": "10:00",
              "stop": "23:00"
            }
          ]
        },
        {
          "weekday": "sunday",
          "hours": [
            {
              "start": "10:00",
              "stop": "23:00"
            }
          ]
        }
      ],
      "openingHourSpecialDays": [
        {
          "date": "2020-12-24",
          "hours": [
            {
              "start": "10:00",
              "stop": "16:00"
            }
          ]
        },
        {
          "date": "2020-12-25",
          "hours": [
            {
              "start": "10:00",
              "stop": "16:00"
            }
          ]
        },
        {
          "date": "2020-12-26",
          "hours": [
            {
              "start": "10:00",
              "stop": "16:00"
            }
          ]
        }
      ]
    }
  ]
}

 

Body-voorbeeld – postcode

{
  "key": "listkey",
  "activate": "true",
  "type": "zipcode",
  "countryCode": "SE",
  "agents": [
    {
      "id": "1",
      "name": "Agent name 1",
      "address1": "Test gatan 1",
      "address2": "",
      "zipcode": "41118",
      "city": "Göteborg",
      "state": "",
      "country": "SE",
      "phone": "07443332211",
      "email": "test@test.com",
      "additionalInfo": "Additional information",
      "flags": [
        "express",
        "hem"
      ],
      "agentZipcodes": [
        {
          "from": "40000",
          "to": "45000"
        },
        {
          "from": "46000",
          "to": ""
        }
      ],
      "openingHourWeekdays": [
        {
          "weekday": "monday",
          "hours": [
            {
              "start": "08:00",
              "stop": "22:00"
            }
          ]
        },
        {
          "weekday": "tuesday",
          "hours": [
            {
              "start": "08:00",
              "stop": "22:00"
            }
          ]
        },
        {
          "weekday": "wednesday",
          "hours": [
            {
              "start": "08:00",
              "stop": "22:00"
            }
          ]
        },
        {
          "weekday": "thursday",
          "hours": [
            {
              "start": "08:00",
              "stop": "22:00"
            }
          ]
        },
        {
          "weekday": "friday",
          "hours": [
            {
              "start": "08:00",
              "stop": "22:00"
            }
          ]
        },
        {
          "weekday": "saturday",
          "hours": [
            {
              "start": "08:00",
              "stop": "22:00"
            }
          ]
        },
        {
          "weekday": "sunday",
          "hours": [
            {
              "start": "08:00",
              "stop": "22:00"
            }
          ]
        }
      ],
      "openingHourSpecialDays": [
        {
          "date": "2018-04-27",
          "hours": [
            {
              "start": "10:00",
              "stop": "16:00"
            }
          ]
        },
        {
          "date": "2018-04-28",
          "hours": [
            {
              "start": "10:00",
              "stop": "16:00"
            }
          ]
        },
        {
          "date": "2018-10-10",
          "hours": [
            {
              "start": "10:00",
              "stop": "16:00"
            }
          ]
        }
      ]
    }
  ]
}

 

Antwoordvoorbeeld

{
  "id": "11111"
}

Voor een beschrijving van eigenschappen verwijzen wij u naar de Eigenschappenreferentiegids.

Voor schema en testen verwijzen wij u naar https://api.unifaun.com/rs-docs/ en navigeer naar /agents POST.

 

 

Agentenlijsten ophalen

GET /agents

Haalt alle aangepaste agentenlijsten op in de Delivery Checkout.

 

Antwoordvoorbeeld

[
  {
    "id": "11111",
    "name": "listkey",
    "active": true,
    "status": "OK",
    "created": "2021-05-19T14:08:00.179+0000"
  }
]

Voor een beschrijving van eigenschappen verwijzen wij u naar de Eigenschappenreferentiegids.

Voor schema en testen verwijzen wij u naar https://api.unifaun.com/rs-docs/ en navigeer naar /agents GET.

 

 

Een agentenlijst activeren

POST /agents/{id}

Activeert een aangepaste agentenlijst.

 

URI-parameters

Agent list id string Identificatie van de agentenlijst Vereist

 

Er wordt geen antwoordtekst geretourneerd wanneer een agentenlijst succesvol is geactiveerd.

Voor een beschrijving van eigenschappen verwijzen wij u naar de Eigenschappenreferentiegids.

Voor schema en testen verwijzen wij u naar https://api.unifaun.com/rs-docs/ en navigeer naar /agents/{id} POST.

 

 

Een agentenlijst verwijderen

DELETE /agents/{id}

Verwijdert een agentenlijst.

 

URI-parameters

Agent list id string Identificatie van de agentenlijst Vereist


Er wordt geen antwoordtekst geretourneerd wanneer een agentenlijst succesvol is verwijderd.

Voor een beschrijving van eigenschappen verwijzen wij u naar de Eigenschappenreferentiegids.

Voor schema en testen verwijzen wij u naar https://api.unifaun.com/rs-docs/ en navigeer naar

/agents/{id} DELETE.

Verwante artikelen